Skip to main content

Authorization

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

Kargo

Prerequisites​

Before creating a Kargo credential, you need to obtain your Kargo username and password from your Kargo account. These credentials are required to authenticate with the Kargo Data Sharing API.

To obtain your Kargo credentials, you need to have a Kargo account. Once you have access to your account, you can use your existing Kargo username and password to authenticate with the API. The username and password are used to obtain an access token through the Kargo authentication endpoint. The access token is then sent in the Authorization header with the Bearer prefix for all API requests to the Kargo Data Sharing API. The Kargo Data Sharing API provides access to advertising performance reports, campaign data, and analytics information. For detailed information about authentication and available API endpoints, refer to the Kargo Data Sharing API documentation.

Create a Kargo Credential​

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

New Credential Overlay – Kargo

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

Username + Password Authentication​

Kargo uses username and password authentication to obtain an access token. The username and password are sent to the Kargo authentication endpoint to obtain an access token, which is then used to authenticate API requests.

  1. Enter your Kargo username in the Username field. This is the username you use to sign in to your Kargo account. The username is used along with the password to obtain an access token for API authentication.

  2. Enter your Kargo password in the Password field. This is the password you use to sign in to your Kargo account. The password is used along with the username to obtain an access token for API authentication. The password is sensitive information and must be kept confidential.

    Keep your password secure and do not share it publicly. The password provides access to your Kargo account data and should be treated as sensitive information. Your Kargo username and password are the same credentials you use to sign in to your Kargo account. The credentials are sent to the Kargo authentication endpoint (https://datasharingapi.prod.kargo.com/v1/authenticate) to obtain an access token. Nexla automatically obtains and refreshes the access token as needed. The access token is sent in the Authorization: Bearer {token} header for all API requests to the Kargo Data Sharing API. For detailed information about authentication, token management, and available endpoints, see the Kargo Data Sharing 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.