API OAuth Keys tool

Introduction

The API OAuth Keys tool allows program administrators to generate and manage API keys for your program, without having to contact Achievers' API Support team. These keys can be shared with your company’s (or third-party) developers for building integrations between your Achievers program and other applications (e.g., Workday, SharePoint, Salesforce).
Note:
• You must agree to our API terms and conditions prior to getting production access to the API OAuth Keys tool.
• The API keys for integrations developed prior to March 2018 do not appear in the API OAuth Keys tool.
The Achievers API uses the OAuth 2.0 protocol for authentication and authorization. For more information, go to Authentication in the Achievers developer portal.

❗️

API OAuth Keys tool is for Program Administrators only

Only the program administrators for your Achievers program have access to this tool in the Client Admin Panel (CAP). Share this documentation with your program administrator, or this information is also available to them on Achievers Success Community.

Creating an API OAuth key

  1. Go to the side navigation bar in your program, and click Admin Tools  API OAuth Keys.
    Note: If you cannot access this page, contact the Achievers’ Customer Success team. You must agree to
    our API terms and conditions prior to getting access to this page.
  2. Click Create Key.
  3. In the Key Name field, enter the name of your integration.
    Note: The Key Name may be visible to your users, depending on your integration.
  4. If your integration requires user authorization, select the checkbox, get the redirect URL from your developer(s), and enter it in the Redirect URL field.
  5. Click Save Key. The Key Name, Client ID, and Client Secret appear.

Sharing an API OAuth key

Once you’ve created your key, provide the Client ID and Client Secret to the developer(s). These keys grant specific users/developers permission to access your program’s data and should be safely controlled and shared only as needed.
To share an API OAuth Key with developer(s):

  1. On the API OAuth Keys page, click the clipboard icon for the Client ID.
  2. Paste the Client ID into an email or a private message to your developer(s).
  3. Repeat the steps above for the Client Secret.

Editing an API OAuth key

If necessary, the program admin can edit the Key Name and the user authorization details.

To edit an API OAuth Key:

  1. On the API OAuth Keys page, click Edit Key Details.
  2. Edit the Key Name or user authorization details.
  3. Click Save Key. The updated information appears on the page.

Disabling and re-enabling an API OAuth key

If necessary, program admins can disable an active key or re-enable an inactive one. When you disable a key, any tokens that are associated with it are revoked and any related integrations will no longer work.

To disable an API OAuth Key:

  1. On the API OAuth Keys page, click Edit Key Details on the key that you want to disable.
  2. Click Disable Key.
  3. Confirm that you would like to disable the key by clicking Disable Key in the pop-up message.

To re-enable an API OAuth Key:

  1. On the API OAuth Keys page, click Disabled Keys to view a list of disabled keys.
  2. Click Edit Key Details on the key that you want to re-enable.
  3. Click Enable Key.
  4. Confirm that you would like to re-enable the key by clicking Enable Key in the pop-up message.