Skip to main content

Authorization

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

Kapost

Prerequisites​

Before creating a Kapost credential, you need to obtain your Kapost API token and identify your Kapost subdomain. The API token and subdomain are required to authenticate with the Kapost API.

To obtain your API token, sign in to your Kapost account and navigate to your profile settings. On your edit profile page in Kapost, there is an API Token section that contains the authentication token credential. You can copy this token to use for API authentication. The API token is used along with your Kapost subdomain to authenticate all API requests to the Kapost API. Your Kapost subdomain is the <your-instance> part of your Kapost URL. For example, if your Kapost URL is https://acme.kapost.com, your subdomain is acme. The subdomain is used to construct API endpoint URLs for your specific Kapost instance. For detailed information about obtaining API tokens, API authentication, and available endpoints, refer to the Kapost API documentation and Kapost API getting started guide.

Create a Kapost Credential​

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

New Credential Overlay – Kapost

KapostCred.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.

Basic Authentication​

Kapost uses Basic Authentication with an API token for all API requests. The API token is used as the username in Basic Authentication, and the password is set to "x". The subdomain is used to construct the API endpoint URLs for your specific Kapost instance.

  1. Enter your Kapost subdomain in the Kapost Subdomain field. This should be the subdomain portion of your Kapost URL. For example, if your Kapost URL is https://acme.kapost.com, you would enter acme in this field. The subdomain is used to construct API endpoint URLs in the format https://{subdomain}.kapost.com/api/v1/{endpoint} for your specific Kapost instance.

  2. Enter your Kapost API token in the Token field. This is the API token you obtained from your Kapost profile settings (Edit Profile > API Token section). The API token is used as the username in Basic Authentication to authenticate API requests. The API token is sensitive information and must be kept confidential.

    Keep your API token secure and do not share it publicly. The API token provides access to your Kapost account data and should be treated as sensitive information. Your Kapost API token can be found on your edit profile page in Kapost, in the API Token section. The API token is used as the username in Basic Authentication, with the password set to "x". If your API token is compromised, you should immediately regenerate it in your Kapost account settings. The subdomain identifies your specific Kapost instance and is used to construct API endpoint URLs. For detailed information about obtaining and managing API tokens, API authentication, and available endpoints, see the Kapost API documentation and Kapost API getting started guide.

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.