Skip to main content

Authorization

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

Instatus

Prerequisites​

To connect Nexla to Instatus, you will need an Instatus account and an Instatus API key. Instatus uses API key authentication with Bearer tokens—all API requests are authorized by including your API key in the Authorization header of each request.

Obtain Your Instatus API Key​

Instatus API keys are generated from the Developer section of your Instatus account settings. Each API key provides full access to the Instatus API on behalf of your account, so it should be stored securely and not shared.

  1. Sign in to your Instatus account at instatus.com.

  2. Navigate to your account developer settings by going to instatus.com/app/developer, or by clicking your profile avatar in the upper right corner and selecting Developer Settings.

  3. On the Developer Settings page, locate the API Key section.

  4. Click Generate API Key (or copy your existing key if one has already been generated). Your API key will be displayed on screen.

Important

Copy your API key immediately and store it in a secure location such as a password manager or secrets vault. Instatus does not display the full key again after you leave the page. If you lose access to your key, you will need to regenerate it.

  1. Keep this API key available — you will enter it in the Nexla credential form in the steps below.

For additional information about the Instatus API and authentication, refer to the official Instatus API documentation.

Create an Instatus Credential​

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

  1. Enter your Instatus API key in the API Key field. This key authenticates Nexla with the Instatus API using Bearer token authentication — Nexla will include it automatically in the Authorization: Bearer <API_KEY> header of all requests made on behalf of this credential.

    Your Instatus API key grants full access to your Instatus account via the API. Treat it like a password — do not share it or include it in source code repositories. Nexla stores credentials securely and uses them only to make authorized API calls on your behalf.

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.