API Keys

API Keys



API Keys List & Options

API Keys allows users to create API access across the Experience Cloud Platform, specific to KEY TYPE. The main screen lists all keys created within the platform with navigation options to Setup Integration (using OpenConnect), Audit the creation of new keys and Generate New Key. Each section will be listed below with further information.

Setup Integration

 Directs users to create a New OpenConnect API Key. Please see OpenConnect for more details on creating an OpenConnect.

Audit

 Audit provide an audit trail of changes to API Keys. When interaction with the button users will see the following modal.

API Key Audit Modal

This modal provides details of changes to API Keys by:
  1. Action performed on Key
  2. Users whom performed change/action
  3. Date of when change/audit was captured.

Generate New Key

 Generate New Key allows users to add a new API Key to the Experience Cloud platform. Users are directed to the following screen:

Create API Key Screen

The Creation of a new API Key 

  1. Name: This is a required field and is used to name the API Key (important to have something identifiable).
  2. Description: Optional however recommended to define what actions or activities the API Key is used for.
  3. Allow-List: Optional field used to apply authenticated domains. If left blank, Experience Cloud will accept the key from any origin.
  4. Key Type: An API Key can only be created to a single Key Type. Below are a list of Key Types and their definitions: 
    1. Client
      1. Events that are triggered via the Experience Client or CRM workspace. Example: Action Buttons, Workspace Events, and so on.
    2. OpenConnect
      1. Events driven from the use of OpenConnect. See OpenConnect for more information.
    3. QueueAdapter
      1. Events driven from the QueueAdapter
    4. Telephony
      1. Legacy use of "Media Bar" events and actions.
  5. Generate Token
    1. Will advance the creation of an API Key into the next step: New API Key Generated

New API Key Generated

New API Key Generated Screen

Upon the setup and creation of API Key, the New API Key Generated screen will appear. There are requirements to proceed and "save" the API Key.

Warning
The API Key should be copied and securely stored. These keys are created once and will not be able to copied again. You must confirm you have stored the API Key before proceeding forward.

Acknowledge to proceed

Clicking "Setup Integration" will auto direct you to "OpenConnect" to show how these API Keys can be used and leveraged further. 


Edit API Key

API Keys can be edited by selecting the Edit options from the main API Keys screen.


You can only Edit the Name and Description of the selected API Key.


"Legacy" API Keys

Alert
For administrators using Legacy Administration, follow the steps below to create or retrieve your API key.
Expand Navigation Menu and Click "System Settings" 

• Select "API Key" from Menu
Warning
Warning: Clicking “Re-generate” will invalidate the current key and remove all existing instances where it is used.
You must copy the new key and update all locations where the previous key was in use.

• Click “Re-generate”
• Copy New Key
• Update any references of the old key with newly re-generated key.

    ​
    Still can’t find an answer?
    Send us a ticket and we will get back to you.

      • Related Articles

      • API Key

        Coming soon! Guidelines for connecting your API Key apps & datasource in Integrations.

      • Required: URL Allow List & API Endpoints

        This section includes Allow List URLs specific to OpenMethods services and owned connections. You can use this information to allow information from the URLs listed below to pass through any pop-up blockers. Our Recommended Method ⚠️ OpenMethods is ...

      • Screen Pop Activities: Zendesk Search REST API

        Zendesk Search REST API Activity The Zendesk Search REST API activity lets you search for Users or Tickets directly within your workflow. Search Options 1: Select User or Ticket as your search type. 2 : This choice determines which fields become ...

      • OpenConnect

        OpenConnect replaces "Connect API" - Please use this article to test connectivity and API calls into OpenConnect Why Is OpenConnect Critical To Oracle & Zendesk? OpenConnect allows Experience Cloud to integrate with various contact center platforms, ...

      • inContact Configuration Guide

        Info This document is applicable to both InContact Central and UserHub configurations. Requirements The following items should be collected from the InContact Administration site. These items will be used in OpenMethods Config Server UI and Queue ...