Skip to main content

Authorization

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

Apptivo

Prerequisites​

The Apptivo Developer API authenticates every request with a pair of credentials — an API Key and an Access Key — that are passed alongside each call as URL parameters. Both values are tied to your Apptivo firm, and the API is available only on paid Apptivo subscription plans.

Before creating a credential in Nexla, sign in to Apptivo as a user with administrative access to the firm so that you can view and, if needed, regenerate these keys.

Retrieve Your API Key and Access Key​

Both keys are generated automatically when a paid Apptivo subscription is provisioned and can be retrieved or regenerated from the Apptivo Business Settings.

  1. Sign in to your Apptivo account at https://app.apptivo.com.

  2. Hover over your name in the upper-right corner of the screen, and select Business Settings from the dropdown menu.

  3. In the left-hand navigation panel, click API Access to open the API credentials page.

  4. Copy the API Key value, and store it in a secure secret manager. This key identifies your Apptivo firm to the API.

  5. Copy the Access Key value, and store it in a secure secret manager. This key is required alongside the API Key on every API request.

    If a new pair of keys needs to be issued — for example, if the existing keys are believed to be compromised — click Regenerate on the API Access page to invalidate the current keys and generate new values. Any integrations that use the previous keys must be updated with the new values after regeneration.

For complete information about Apptivo API authentication, see the Apptivo Developer API Getting Started guide and the Apptivo API Guide.

Important

The API Key and Access Key values grant full programmatic access to your Apptivo firm. Treat them like passwords — store them in a secure secret manager, never commit them to source control, and regenerate them immediately if you suspect they have been exposed.

Create an Apptivo Credential​

  • To create a new Apptivo 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.

Authentication Settings​

  1. Enter your Apptivo API Key value in the API Key field. This is the value retrieved from Business Settings > API Access in Apptivo and is treated as a secret.

  2. Enter your Apptivo Access Key value in the Access Key field. This is the second key retrieved from the API Access page and is required on every Apptivo API request alongside the API Key.

    Both the API Key and Access Key must be from the same Apptivo firm. Mixing keys from different firms will cause authentication to fail when Nexla calls the Apptivo API.

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.