Skip to main content

Authorization

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

Coassemble

Prerequisites​

Before creating a Coassemble credential in Nexla, you must enable the headless API in your Coassemble workspace and obtain your API credentials. The Coassemble headless API authenticates each request using two values issued together: a User ID and an API key (also called the User Token). Both values are combined into a COASSEMBLE-V1-SHA256 Authorization header, which Nexla constructs automatically once you supply the two values.

Enable the API and Retrieve Your Credentials​

  1. Sign in to your Coassemble workspace at coassemble.com.

  2. Open the Settings menu, and navigate to the Add-ons section.

  3. Locate the API add-on, and click it to open the API configuration page.

  4. Complete the short entry survey, and enable the API for your workspace.

    After enabling the API, your workspace will initially be in test mode, allowing you to configure and validate your integration before purchasing and going live. The same credentials are used in test mode and live mode.

  5. Once the API is enabled, your User ID and API key are displayed on the API add-on page. Copy both values and store them securely, as the API key authenticates Nexla with your account on every request.

For complete information about the Coassemble headless API and its endpoints, refer to the Coassemble Developers documentation.

Keep your API key secure

Treat your Coassemble API key like a password. Anyone with the User ID and API key can read and modify courses, learners, and identities in your workspace. If a key is exposed, regenerate it from the API add-on page and update the credential in Nexla.

Create a Coassemble Credential​

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

Coassemble uses API key authentication. Both the User ID and API key are required and are issued together from your workspace Add-ons settings.

  1. Enter your Coassemble workspace User ID in the User ID field. This value is found on the API add-on page in your workspace settings, alongside the API key.

  2. Enter your Coassemble API key in the API Key field. This is the User Token displayed on the same API add-on page. Nexla combines the User ID and API key into the COASSEMBLE-V1-SHA256 Authorization header that the headless API requires.

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.