Skip to main content

Authorization

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

Aventri

Prerequisites​

Before creating an Aventri credential in Nexla, you need to obtain your API key and Account ID from your Aventri account. These credentials authenticate Nexla with the Aventri API and should be kept secure.

Obtain Aventri API Credentials​

  1. Sign in to your Aventri account.

  2. Navigate to Settings or API Settings in your Aventri account to access the API configuration page.

  3. Locate the API or Developer section in the settings menu. This section contains your API credentials and access tokens.

  4. Copy your Account ID. This is a unique identifier for your Aventri account that is used together with your API key to authenticate API requests.

  5. Copy your API Key. This is a secret key that authenticates API requests and provides access to your Aventri account data. The API key is used together with the Account ID to obtain an access token for API authentication.

    Your Account ID and API Key are required for all Aventri API operations. Keep these credentials secure and do not share them publicly or commit them to version control systems. Aventri uses token-based authentication where the API key and Account ID are used to obtain an access token. For detailed information about Aventri API authentication, see the Aventri API documentation.

Create an Aventri Credential​

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

New Credential Overlay – Aventri

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

Authentication Configuration​

  1. Enter your Aventri Account ID in the Account ID field. This should be the unique identifier for your Aventri account, obtained from your Aventri account settings.

  2. Enter your Aventri API key in the Key field. This key authenticates Nexla with the Aventri API and should match the API key obtained from your Aventri account settings. The API key is used together with the Account ID to obtain an access token for API authentication.

    The Account ID and API Key provide full access to your Aventri account data through the API. Keep these credentials secure and do not share them publicly or commit them to version control systems. Aventri uses token-based authentication where these credentials are used to obtain an access token, which is then used in the Authorization header as a Bearer token for all API requests.

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.