Skip to main content

Authorization

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

Beekeeper

Prerequisites​

Before creating a Beekeeper credential in Nexla, you need to obtain an API access token from your Beekeeper account. Beekeeper uses API key authentication with token-based access for secure API access.

Beekeeper API Access Token Setup​

Beekeeper API requires an access token for authentication. The access token provides secure, programmatic access to your Beekeeper account data through the API.

  1. Access Beekeeper Developer Portal: Sign in to your Beekeeper account and navigate to the Beekeeper Developer Portal or access API settings through your Beekeeper account administration.

  2. Create or View API Access Token: Create a new API access token or view an existing one in your Beekeeper account settings. API access tokens are used to authenticate requests to the Beekeeper API.

  3. Review API Permissions: Ensure your API access token has the necessary permissions to access the data and perform the actions you need. Different tokens may have different scopes and permissions.

  4. Copy Access Token: Copy your API access token immediately after viewing it. Keep the token secure, as it provides access to your Beekeeper account data.

    Beekeeper API access tokens provide programmatic access to your Beekeeper account. Keep your access token secure and do not share it publicly or commit it to version control systems. The access token is sent in the Authorization: Token {token} header for all API requests. If you suspect your access token has been compromised, regenerate it immediately in your Beekeeper account settings. For detailed information about obtaining an access token, see the Beekeeper API documentation.

For additional information about Beekeeper API authentication and credential management, see the Beekeeper API documentation.

Create a Beekeeper Credential​

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

New Credential Overlay – Beekeeper

BeekeeperCred.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.

Beekeeper API Configuration​

  1. Enter your Beekeeper API access token in the API Key Value field. This should be the access token obtained from your Beekeeper account. The access token is used to authenticate requests to the Beekeeper API.

    The API access token provides secure access to your Beekeeper account data through the API. The access token is sent in the Authorization: Token {token} header for all API requests. Keep your access token secure and do not share it publicly or commit it to version control systems. For detailed information about Beekeeper API authentication, see the Beekeeper 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.