Skip to main content

Authorization

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

Captain Data

Prerequisites​

To connect Nexla to Captain Data, you will need a Captain Data API key and your project's unique identifier (Project UID). Captain Data uses API key authentication, with the key passed in the Authorization request header alongside your Project UID in a separate x-project-id header.

Obtain a Captain Data API Key and Project UID​

Captain Data API keys are generated directly from your Captain Data workspace settings. Each API key is tied to the user account that created it within a given workspace.

  1. Sign in to your Captain Data workspace at app.captaindata.com.

  2. Navigate to Settings > Developers (or go directly to https://app.captaindata.com/settings/developers) to access your API credentials.

  3. In the API Keys section, click Generate API Key or Create New Key to create a new API key for use with Nexla.

  4. Enter a descriptive label for the key (for example, "Nexla Integration") so you can identify its purpose later.

  5. Copy the generated API key immediately and store it in a secure location. For security reasons, Captain Data may not display the full key value again after the initial creation.

  6. On the same Developers settings page, locate your Project UID (also referred to as the Project ID). This is the unique identifier for your Captain Data project workspace and is required alongside the API key for all authenticated API requests.

Important

Treat your Captain Data API key as a sensitive credential. Do not share it in emails, code repositories, or other insecure locations. If a key is ever compromised, revoke it immediately from your Captain Data settings and generate a replacement key.

API keys in Captain Data are tied to your individual user account within a workspace. If other team members need API access, they must generate their own API keys from their own accounts. For additional guidance, see the Captain Data API documentation.

Create a Captain Data Credential​

  • To create a new Captain Data 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 Captain Data API key in the API Key field. This key authenticates Nexla with the Captain Data API and is sent as the value of the Authorization: x-api-key header with each API request. The key should be kept confidential and only shared with authorized systems such as Nexla.

Project ID​

  1. Enter your Captain Data Project UID in the Project ID field. The Project UID is the unique identifier for your Captain Data workspace project and is required alongside the API key to scope API requests to the correct project. You can find this value on the Settings > Developers page of your Captain Data workspace.

    The Project UID is different from your account username or workspace name. It is a unique alphanumeric identifier assigned by Captain Data to your project. Ensure you copy the exact value shown on the Developers settings page.

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.