Skip to main content

Authenticate with your email and password

Lisa Wong
Updated

Use your login information to retrieve a bearer token and access Alida APIs.

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

Note:
  • For more information on how to authenticate between services, see Create an authentication key.
  • 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 Shared responsibility.

  1. In a REST client, create a new API request.
  2. 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
    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
    Key Value
    applicationname Find the applicationname.
    1. Log in to the Alida platform.
    2. In the navigation bar, click Product Settings > API.
    3. In the API URL section, find the community API URL.
    4. In the community API URL, select the end of the URL after applications/. This is the applicationname.
    Note: The applicationname is also the {communityApiKeyName}. For more information, see URL structure.

    grant_type password
    Username Username used to log in to the Alida platform.
    Password Password used to log in to the Alida platform.
  3. Send the request.
    A successful request returns values for the following attributes:
    • access_token
      Note: The access_token is the bearer token.
    • token_type
    • expires_in
    • refresh_token
  4. Use the bearer token to make API requests.
    Note: Bearer tokens created from authenticating by user information expire after 5 minutes.
  5. Optional: Use the refresh token to extend your session by 20 minutes.
    1. In a REST client, create a new API request.
    2. Enter the following values in the request.
      HTTP Request Parameters Values
      Method Request type POST
      Resource URL URL https://api.{region}.alida.com/oauth2/token
      Headers Required headers
      Key Value
      Content-Type application/x-www-form-urlencoded
      Body Required body
      Key Value
      grant_type refresh_token
      refresh_token Use the refresh_token returned in step 3.
    3. Send the request.
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.
Parent topic: Authentication
Related information

Related articles

Powered by Zendesk