Skip to main content

Authorization

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

Choozle

Prerequisites​

Before creating a Choozle credential, you need to obtain authentication credentials from your Choozle account. Choozle uses HMAC-SHA256 authentication with a User Email and API Private Key to authenticate API requests.

To use Choozle with Nexla, you need:

  • Access to your Choozle account
  • A Choozle account with appropriate permissions to access the resources you want to work with
  • Your User Email associated with your Choozle account
  • Your API Private Key for creating HMAC signatures

The Choozle API uses HMAC-SHA256 authentication, which requires generating a signature using your API Private Key, User Email, and a timestamp. Nexla automatically handles the HMAC signature generation for all API requests. For detailed information about Choozle authentication, API key setup, and HMAC signature generation, refer to the Choozle API documentation.

Create a Choozle Credential​

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

New Credential Overlay – Choozle

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

HMAC-SHA256 Authentication Configuration​

  1. Enter your Choozle User Email in the User Email field. This is the email address associated with your Choozle account that will be used for HMAC signature generation. The default value is user@company.net if not specified.

  2. Enter your Choozle API Private Key in the Choozle API private key field. This is the API private key you obtained from your Choozle account settings. The API private key is used together with your User Email and a timestamp to generate HMAC-SHA256 signatures for authenticating API requests.

    Keep your API private key secure and do not share it publicly. The API private key provides access to your Choozle account and should be treated as sensitive information. Choozle uses HMAC-SHA256 authentication, and Nexla automatically generates the required signature for each API request using your User Email, API Private Key, and a timestamp. The signature is included in the request body along with the email and timestamp. For detailed information about obtaining and managing API keys, see the Choozle 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.