Generate an API Key in 8x8 Admin Console

Generate an API Key in 8x8 Admin Console

Objective

Generate an API key in Admin Console.

Applies To

  • 8x8 Admin Console
  • API Key

Procedure

Admin Console allows customers to create API keys for a number of APIs. These credentials can be used to access the underlying APIs securely.

API credentials/Apps can be created with access to one or more APIs and multiple sets of credentials/Apps can be created.

Customers can generate keys for the following APIs using this method:

  • Analytics & Content
    • Analytics for Contact Center
    • Call Recordings & Storage (Cloud Storage Service)
    • Customer Experience Post Call Survey
    • Customer Experience Recent Calls
    • Quality Management & Speech Analytics
  • Actions
    • CHAPI Work Chat
    • Contact Center Chat

Assign API Key permission to users

To manage API access keys, a user first needs access to this permission through Roles and Permissions.

This permission is enabled for users of the default Company Admin Role or a custom role can be created for specific users using the application: 8x8 Admin Console and the permission: Application Credentials. 

Create an app for the API

  1. From the menu, go to API Keys.
  2. Click Create app.
  3. Enter a name for the app.
  4. Select the API/s from the list of available APIs.
  5. Save the app. This automatically generates the API key.

Fetch the API key for the app

  1. Go to the list of apps listed under the API Keys.
  2. Select to edit the app you just created.
  3. Note that the API key and the secret code are now visible in the protective mode.
  4. Click 
     to view the key and the code.
  5. Copy and store the key for authentication.

Revoke access to any of the supported 8x8 API

You can simply delete the app to remove access to the API. Deleting the app revokes the API key and blocks access to the APIs selected in the app.

Authentication

After fetching the API key, go to the 8x8 Developer site, select the API you wish to use, and use the key to authenticate the API calls.

Additional Information

To create a Call Recordings API Key and Secret, the user must first have the Storage API assignment. This assignment is granted by the Super Admin.

 


    • Related Articles

    • Cloud Storage Service Public API Creating Keys and Authenticating

      Objective Create keys and authenticate to use the Cloud Storage Service Public API. Applies To Admin Console Cloud Storage Service Public API Procedure Assign the Storage API Role to a User Log in to Admin Console as a Super User. From the left menu, ...

    • Generate a Users Report in Admin Console

      Objective Download user profile information in 8x8 Admin Console. Applies To Admin Console Procedure Log in in to Admin Console. Select Users. On the Users page, select Generate users report. The following window should appear. Select the desired ...

    • Inspect Saved Configuration Error When Saving Line Key Configuration in 8x8 Admin Console

      Symptom An error banner with the following message is displayed when attempting to save Line Key Configuration: Error while saving line key configuration. Failed and creating power key. Please inspect the saved configuration. Applies To Admin Console ...

    • Audit Management Generate Archive Not Working in 8x8 Admin Console

      Symptom When attempting to generate an archive on 8x8 Admin Console's Audit Management page, the option is grayed out and clicking on it does nothing. Applies To Admin Console Audit Events Resolution The Generate Archive option becomes active after a ...

    • Viewing and Creating X Series User Roles

      Objective View and create user roles in Admin Console using role-based access control (RBAC). Applies To Admin Console Role-Based Access Control Procedure Only users with the Company Admin role and IT Admin Role can view and create user roles. ...