Skip to main content

Authorization

Follow this guide to create a new Gem API credential that will allow Nexla to authenticate to and exchange data with your Gem account.
gem_api_auth.png

Gem API

Prerequisites​

Before creating a Gem API credential, you need to obtain an API key from your Gem account. The API key is required to authenticate with the Gem API.

To obtain your API key, you need to have a Gem account with API access enabled. Once you have access to your account, you can generate an API key from your Gem account settings. The API key is sent in the X-API-Key header for all API requests to the Gem API. For detailed information about API key setup and authentication, refer to the Gem API documentation.

Create a Gem API Credential​

  • To create a new Gem API credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Gem API

GemCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Key Authentication​

  1. Enter your Gem API key in the API Key Value field. This is the API key you obtained from your Gem account settings. The API key is sent in the X-API-Key header for all API requests to the Gem API.

    Keep your API key secure and do not share it publicly. The API key provides access to your Gem account and should be treated as sensitive information. You can view and manage your API keys in your Gem account settings. The API key is sent in the X-API-Key header for all API requests to the Gem API. For detailed information about obtaining and managing API keys, see the Gem API documentation.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.