Setup and Testing

New
  • Published on Jan 30, 2025
  • 2 minute(s) read

Congratulations on building your Gladly integration. Now, you can test the myriad possibilities of the Gladly API in a safe, secure space. This guide will help you understand the testing and iteration process.

Sandbox environment

If you do not have a sandbox environment and are interested in purchasing one, please contact your Gladly CSM or Gladly Support team. Sandbox environments are a great way to test your code without impacting your production environment.

Your sandbox environment will be accessible via the URL below where organization is your company name.

https://{organization}.gladly.qa

Set up API Users

Gladly Administrators can set API permissions on an Agent-by-Agent basis. We'll discuss how this maps to API access in the Authentication section below. Of course, the API User will also have access to Gladly overall.

To allow a user to create API tokens and access the API:

  1. Log in to your Gladly instance.

  2. Open the menu on the top left-hand corner of the page.

  3. Navigate to Settings > Users.

  4. Search and click the user profile that should have access.

  5. You'll see a permission called API User. Select it, while keeping the user's Agent role intact.

  6. Click Save to give access.

We recommend creating a dedicated user to make API calls whose account won't be used for Agent and organization management. This will help with future audits of API and agent activity.

API tokens

You must create an API token to access Gladly API resources (see above).

Create

If your profile already has access to the API User permission, you'll see a menu item titled Settings.

  1. Click Settings.

  2. Click API tokens then Add Token button on the upper right-hand corner of the page.

  3. A token will be generated and named New Token by default.

    • If you have existing tokens, it might be named New Token 2, New Token 3, etc.

  4. Click the name to rename.

You will only see a new token once before you navigate away from the page. This token will be associated with your Agent profile.

Replace and Rotate

If you lose this token or it is time to rotate your application keys:

  1. Generate a new token.

  2. Store the new token in a secure location.

  3. Delete the old token.

  4. Update your applications and scripts with the new token.

Authentication

Gladly API uses token-based Basic Authentication. API tokens are associated with designated Gladly users. Your user must have the API user permission to create and use an API token. An API token can be used to perform any API request without restriction.

The credentials must be passed via an Authorization HTTP header. All requests must be made over HTTPS.

Related docs