API Keys screen reference

To view the API Keys screen, go to System Management Module that allows performing suite-wide system management activities from a single, Web-based application, the Enterprise Manager.. Under License Management, select API Keys.

API Keys page

Fields on the API Keys screen

Field

Description

Key ID

Randomly generated unique alphanumeric identifier of the key.

Type

The value can be Internal or External.

  • Internal. Enables Verint products to communicate with Verint servers. These keys are needed when a Verint product, such as Face to Face Interaction Recorder or Screen Capture, runs on a non-Verint installed server or system, such as an agent desktop.

  • External. Allows published APIs to access product components and services. Third parties use external keys to use the Impact 360 services.

Enabled

Indicates whether the key is enabled for use. When generated, keys are enabled by default.

Description

A user-defined description of the purpose of the key.

Date Issued

The date and time the key was generated. The date and time format depends on the Regional Format a user selects in the User Preferences settings.

Key Value

Displays the alphanumeric value of the key. This field is blank by default. To display the key value, see Actions below.

Actions

Contains the icons for the available actions. You must move your mouse over the Actions column to display these icons.

Show the key value icon Show the key value icon.Displays the alphanumeric value of the selected key in the Key Value column and enables the copy icon.

Copy icon Copy icon. Copies the selected key value to the clipboard. (You must click the Show the key value icon before you can copy the key value.)

Edit iconThe Edit icon . Opens the properties dialog box for the selected API key.

Delete icon The Delete icon . Deletes the selected API key. For a key to be deleted, it must not be enabled or be the only internal API key.

Using API Keys when automating tasks

Generate an API Key

Copy an API Key

Display an API Key value

Delete an API key