Create an authentication key

Create an API credential key and retrieve a bearer token to access Alida APIs.

Prerequisites:

You need to accept the terms and conditions for API use before you can create an authentication key.

Note:
  • The application supports the following authentication methods:
    • client_credentials grant

      This is used for machine-to-machine integrations, and is the preferred and most common workflow.

    • password grant

      Use this method if you are accessing Alida's APIs in an interactive way from a UI application. Otherwise, this method is not preferred.

  • You can create a maximum of 10 API credentials.
  • Delimiters are not used in authentication.
  • This task cannot be performed by Authors or Power Users. Only Admins can access the API page and use Alida APIs.

  • Use the appropriate regional endpoint to ensure that you comply with your organization's privacy policy, and applicable laws and regulations. For details about the available regional endpoints, and how to identify your organization's region, see API Access.

  1. Log in to the Alida Platform.
  2. Create an API credential:
    This is to set up the Client ID and Client Secret used in the API request.
    1. In the navigation bar, click Product Settings > API.
    2. In the API Credentials area, click New Credential.
    3. In the Name field, type a name for the credential.
      The maximum length is 255 characters.
    4. In the Description field, type a description of the credential.
      Tip: Add a description so other administrators will know what the credential is for. For example, "Client ID/Secret for Salesforce integration."
    5. Click Create.
      Result: The new credential appears in the list.
  3. In a REST client, create a new API request.
  4. Retrieve the bearer token by entering the following values to the request:
    HTTP Request Parameters Values
    Method Request type POST
    Resource URL URL https://api.{region}.alida.com/oauth2/token
    Authorization Type Basic Auth
    Username Use the Client ID from the Alida platform.
    Password Use the Client Secret from the Alida platform.
    Headers Required headers
    Key Value
    Content-Type application/x-www-form-urlencoded
    x-api-key Use the API key from the Alida platform.
    Body Required body
    x-www-form-urlencoded is selected.
    Key Value
    grant_type client_credentials
    Note: The Username, Password and x-api-key can be found on the API page in the Alida platform.

  5. Send the request.
    Result: A successful request returns values for the following attributes:
    • access_token
      Note: The access_token is the bearer token.
    • token_type
    • expires_in
  6. Use the bearer token to make API requests.
    Note: Bearer tokens created from API credentials expire after 30 minutes.
After requesting a bearer token, you can use it to access Alida APIs.
  1. Select an endpoint to access from our API documentation.
  2. Create a new request with the bearer token authorization.
  3. Copy and paste the bearer token without quotation marks from the previous request.
  4. Send the request.