Skip to main content

Authorization

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

SpotDraft API

Prerequisites​

Before creating a SpotDraft credential, you need to obtain your Client ID, Client Secret, and optionally a User Email from your SpotDraft account. SpotDraft uses header-based authentication for all API requests, with credentials sent in custom headers.

To obtain your SpotDraft credentials, follow these steps:

  1. Sign in to your SpotDraft account using your administrator credentials.

  2. Navigate to Settings in your SpotDraft account, then select Developer Settings or navigate to Settings > Developer Settings.

  3. Look for the API Credentials or API Keys section in the Developer Settings page.

  4. If you don't have API credentials yet, look for the option to generate or create API credentials.

  5. Click Generate API Credentials or Create API Key to create new API credentials.

  6. Configure your API credentials:

    • Enter a name for the API credentials (e.g., "Nexla Integration")
    • Review and select the permissions or scopes for the API credentials (if applicable)

  7. Click Generate or Create to create the API credentials.

  8. After the credentials are created, you will be provided with your Client ID and Client Secret. Copy both credentials immediately, as the Client Secret may not be accessible again after you navigate away from the page.

  9. Optionally, you can specify a User Email to impersonate a specific user when making API requests. This is useful if you need to access data on behalf of a specific user. If not specified, the API will use the account's default permissions.

  10. Store all credentials securely, as you will need them to configure your Nexla credential. The Client ID and Client Secret are sensitive information and should be kept confidential.

The Client ID, Client Secret, and User Email (if provided) are sent in custom headers (client-id, client-secret, user-email) for all API requests to the SpotDraft API. The credentials authenticate your requests and grant access to SpotDraft resources based on your account permissions. If your credentials are compromised, you should immediately revoke them in your SpotDraft Developer Settings and generate new ones. For detailed information about API authentication, credential generation, and available endpoints, refer to the SpotDraft API documentation.

Create a SpotDraft Credential​

  • To create a new SpotDraft credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – SpotDraft API

SpotDraftCred.png

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.

Header Authentication​

SpotDraft uses header-based authentication for all API requests. The Client ID, Client Secret, and optionally User Email are sent in custom headers for authentication.

  1. Enter your SpotDraft Client ID in the Client ID field. This is the Client ID you obtained from your SpotDraft account settings (Settings > Developer Settings > API Credentials) when generating your API credentials. The Client ID is sent in the client-id header for all API requests to the SpotDraft API.

  2. Enter your SpotDraft Client Secret in the Client Secret field. This is the Client Secret you obtained from your SpotDraft account settings when generating your API credentials. The Client Secret is sent in the client-secret header for all API requests to the SpotDraft API. The Client Secret is sensitive information and must be kept confidential.

  3. Optionally, enter a User Email in the User email to impersonate (optional) field. This should be the email address of a user in your SpotDraft account that you want to impersonate when making API requests. If provided, the User Email is sent in the user-email header for all API requests. If not specified, the API will use the account's default permissions.

    Your SpotDraft API credentials can be found in your SpotDraft account settings under Settings > Developer Settings > API Credentials. The Client ID and Client Secret are generated when you create API credentials.

    These credentials are sent in custom headers (client-id, client-secret, user-email) for all API requests to the SpotDraft API. The credentials authenticate your requests and grant access to SpotDraft resources based on your account permissions.

    If your credentials are compromised, you should immediately revoke them in your SpotDraft Developer Settings and generate new ones. The credentials provide access to your SpotDraft account data and should be treated as sensitive information. Keep your credentials secure and do not share them publicly.

    For detailed information about API authentication, credential generation, and available endpoints, see the SpotDraft API documentation.

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.