Skip to main content

Authorization

Follow this guide to create a new Amperity credential that will allow Nexla to authenticate to and exchange data with your Amperity tenant.
amperity_api_auth.png

Amperity

Prerequisites​

To connect Nexla to Amperity, you need an Amperity tenant with API access enabled, and a user account that has been assigned the Allow API key administration policy. This policy is required to create and manage API keys and generate the access tokens used for authentication.

About Amperity API Authentication​

The Amperity API uses JSON Web Token (JWT) access tokens for authentication. These tokens are issued from API keys that are managed directly within the Amperity user interface. Each API key is a synthetic identity bound to your tenant that grants programmatic access to the Amperity API.

API requests are authenticated by including the access token as a Bearer token in the Authorization request header, along with your tenant ID in the Amperity-Tenant header.

Obtain Your Tenant ID​

Your tenant ID is a unique identifier for your Amperity instance and is required for all API requests.

  1. Sign in to your Amperity account at your tenant URL (e.g., https://app.amperity.com).

  2. Navigate to Settings in the left sidebar.

  3. Click the Security tab.

  4. Under API keys, locate any existing API key in the list, open its row menu (the three-dot menu icon), and select Copy tenant ID.

  5. Save the copied tenant ID — you will need it when configuring the Nexla credential.

Create an API Key and Generate an Access Token​

  1. Sign in to your Amperity account and navigate to Settings > Security.

  2. In the API keys section, click Add API key to create a new key.

  3. Enter a descriptive name for the API key (for example, Nexla Integration) to identify its purpose.

  4. Click Save to create the key. The new API key will appear in the list under API keys.

  5. In the row for your newly created API key, open the row menu and select Generate access token. A dialog will appear showing the generated JWT access token.

Important

Copy and securely store the access token immediately after it is generated. For security reasons, the token value is only displayed once and cannot be retrieved again after you close the dialog. If the token is lost, you will need to generate a new one.

  1. Note that JWT access tokens have an expiration period. Amperity recommends refreshing tokens on a regular basis. When a token expires, return to Settings > Security > API keys and generate a new access token for the same API key.

For additional details about Amperity API key management, token rotation, and security best practices, refer to the official Amperity Authentication documentation.

Create an Amperity Credential​

  • To create a new Amperity 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 Authentication​

Amperity uses Bearer token authentication. You will need the JWT access token generated in the Prerequisites section above and your Amperity tenant ID.

  1. Enter your Amperity JWT access token in the Access Token field. This is the Bearer token that Nexla will include in the Authorization header of all API requests to your Amperity tenant. The token authenticates Nexla to the Amperity API and should be kept secure.

  2. Enter your Amperity tenant ID in the Tenant ID field. This value is used to construct the base URL for all API requests (e.g., https://{tenant-id}.amperity.com/api/) and to populate the Amperity-Tenant request header. Your tenant ID was obtained in the Prerequisites section above.

Amperity JWT access tokens expire after a set period. When your access token expires, you will need to generate a new one in Amperity (Settings > Security > API keys) and update this credential in Nexla with the new token value.

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.