> ## Documentation Index
> Fetch the complete documentation index at: https://playbook.smedleygroup.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Configuring the API Key

> How to create the GKL Platform API key on a Vivenu seller.

## Overview

The GKL Platform uses an API key to call Vivenu for a seller. This SOP covers creating that key. It is configured under the **Developer** menu in the left hand sidebar.

<img src="https://mintcdn.com/smedley_group/InEdB1yfdYn2-5Z7/images/software/third-party/vivenu/hub-deployment/development/configure-api-key/developer-nav.png?fit=max&auto=format&n=InEdB1yfdYn2-5Z7&q=85&s=af66101955a7c5a79f2f5a9a79d3248d" alt="The Developer menu showing Webhooks and API Keys" width="474" height="600" data-path="images/software/third-party/vivenu/hub-deployment/development/configure-api-key/developer-nav.png" />

<Note>
  This SOP assumes you already know how to access and navigate Vivenu. If you need access, [email support](mailto:advanced-technology-c0a6ecefe97b@intake.linear.app).
</Note>

***

## Prerequisites

* Vivenu access for the relevant seller, with **API Keys** installed under Developer Tools. See [Adding Developer Tools](/software/third-party/vivenu/general/vivenu-developer-tools).

***

## Adding the API Key

<Steps>
  <Step title="Open API Keys">
    Navigate to **Developer > API Keys** and click **Create**.

    <img src="https://mintcdn.com/smedley_group/InEdB1yfdYn2-5Z7/images/software/third-party/vivenu/hub-deployment/development/configure-api-key/api-key-create.png?fit=max&auto=format&n=InEdB1yfdYn2-5Z7&q=85&s=52ac1dda31f858b2c14e8870e848dc08" alt="The API Keys page with the Create button" width="1024" height="516" data-path="images/software/third-party/vivenu/hub-deployment/development/configure-api-key/api-key-create.png" />
  </Step>

  <Step title="Name the key and set expiration">
    Set the **Name** to `GKL Platform` and leave **Expiration** as **No expiration**.

    Click **Create**.

    <img src="https://mintcdn.com/smedley_group/InEdB1yfdYn2-5Z7/images/software/third-party/vivenu/hub-deployment/development/configure-api-key/api-key-options.png?fit=max&auto=format&n=InEdB1yfdYn2-5Z7&q=85&s=2cae238193bc8f57518924be29da85e3" alt="The Create API key dialog with name GKL Platform and No expiration" width="846" height="848" data-path="images/software/third-party/vivenu/hub-deployment/development/configure-api-key/api-key-options.png" />
  </Step>

  <Step title="Copy and save the key">
    When the key value is shown, copy it and temporarily save it somewhere local. You will need it for the GKL API configuration (see the [New Hub Region SOP](/software/third-party/vivenu/hub-deployment/development/configure-new-hub-region)).

    <Warning>
      Copy the key now. Once you move past the copy option, the value cannot be viewed again and you will have to create a new key.
    </Warning>
  </Step>

  <Step title="Confirm the key is active">
    The new `GKL Platform` key should now appear in the list with a status of **Active**.

    <img src="https://mintcdn.com/smedley_group/InEdB1yfdYn2-5Z7/images/software/third-party/vivenu/hub-deployment/development/configure-api-key/api-key-result.png?fit=max&auto=format&n=InEdB1yfdYn2-5Z7&q=85&s=6a3b31c2f3bb6b2055ec116030bb2785" alt="The API Keys list showing GKL Platform active" width="2134" height="646" data-path="images/software/third-party/vivenu/hub-deployment/development/configure-api-key/api-key-result.png" />
  </Step>
</Steps>
