Skip to main content

Authorization

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

Imagga API

Prerequisites​

To connect Nexla to the Imagga API, you will need an Imagga account and an API key/secret pair. Imagga authenticates all API requests using HTTP Basic Authentication with your API key as the username and your API secret as the password.

Create an Imagga Account and Obtain API Credentials​

  1. Navigate to imagga.com and click Sign Up to create a new account, or click Log In if you already have an account.

  2. After signing in, navigate to your Dashboard by clicking your account name or profile icon in the upper right corner of the page.

  3. On the Dashboard, locate the API Credentials section. Your API Key and API Secret are displayed here. These two values are required to authenticate all requests to the Imagga API.

    Your API Secret is sensitive — treat it like a password. Do not share it publicly or embed it in client-side code. Imagga requires all API calls to be made over HTTPS to protect your credentials in transit.

  4. Copy your API Key and API Secret and keep them available for the steps below. The Imagga API documentation provides additional details about authentication and usage limits by plan.

Imagga Plan and Usage Limits​

Imagga offers a free tier that allows a limited number of API calls per month, along with paid plans for higher-volume usage. Review the Imagga pricing page to select the plan appropriate for your data integration workload. Rate limits and monthly quotas vary by plan, so ensure your Nexla data flows are designed within the limits of your subscription.

Create an Imagga API Credential​

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

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 to 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 & API Secret​

Imagga uses HTTP Basic Authentication for all API calls. Nexla requires your Imagga API Key and API Secret to construct the proper Authorization header for every request.

  1. Enter your Imagga API Key in the API Key field. This is the username portion of your HTTP Basic Authentication credentials and uniquely identifies your Imagga account.

  2. Enter your Imagga API Secret in the API Secret field. This is the password portion of your HTTP Basic Authentication credentials. Nexla will securely store and use this value to authenticate API requests on your behalf.

    Both the API Key and API Secret are required. Nexla automatically encodes your credentials using Base64 and includes them in the Authorization: Basic header for all requests to the Imagga API — you do not need to encode them manually or add additional authentication headers.

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.