Skip to main content

Authorization

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

Vitally.io

Prerequisites​

To connect Nexla to Vitally.io, you will need a Vitally API key and your Vitally account subdomain. The steps below explain how to obtain both.

Obtain Your Vitally Subdomain​

Your Vitally subdomain is the prefix used in your Vitally login URL. For example, if you log in at https://acme.vitally.io, then your subdomain is acme.

  1. Log in to your Vitally account.

  2. Note the subdomain portion of your browser URL — this is the value you will enter in the Subdomain field when creating the Nexla credential.

Generate a Vitally REST API Key​

Vitally REST API keys are managed in the Vitally settings under Integrations. Each key can be named independently and may be revoked or regenerated at any time without affecting other keys.

  1. Log in to your Vitally account and click your Account Logo in the top-left corner of the application.

  2. Select Settings from the menu to open the settings panel.

  3. Under the Operations section in the left navigation, select Integrations.

  4. On the Integrations page, locate and click Vitally REST API.

  5. On the REST API settings screen, click the Create New API Key button (or the equivalent button to add a new key in the current UI).

  6. Enter a descriptive name for the key — for example, Nexla Integration — so it can be easily identified later.

  7. Click Save or Create to generate the key.

  8. Copy the Secret Token value immediately, as it may not be shown again in full after leaving the page.

Important

Store the API key in a secure location. Anyone with this key can make authenticated requests to your Vitally workspace. Vitally allows you to regenerate or revoke individual keys from the same settings screen if a key is ever compromised.

The Vitally REST API settings screen supports multiple API keys, each with its own name, copyable secret token, copyable Basic Auth header, and individual regenerate/revoke options. For more information, see the Vitally REST API Overview.

Create a Vitally.io Credential​

  • To create a new Vitally.io 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 (Basic Auth)​

Vitally authenticates all REST API requests using HTTP Basic Auth. The API key is used as the Basic Auth username, and the password field is left empty. Nexla handles the Base64 encoding automatically — you only need to provide the raw API key value.

  1. Enter your Vitally REST API key in the API Key field. This value is used as the HTTP Basic Auth username for all requests to the Vitally REST API. It should be kept confidential and treated like a password.

  2. Enter your Vitally account subdomain in the Subdomain field. This is the prefix of your Vitally login URL (e.g., acme from https://acme.vitally.io). The subdomain is used to construct the base URL for all API requests, which takes the form https://{subdomain}.rest.vitally.io.

    EU-region Vitally accounts use a different base URL format. If your workspace is hosted in the EU, contact your Vitally account representative to confirm the correct subdomain value to use.

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.