API ID Management

User Help System

You are here: CME Customer Center >

API ID Management

The API ID Management functionality is used to create and manage IDs that are used to authenticate system-to-system communication to CME Group applications, via API interface.

API authentication options: Basic Auth and OAuth.

To gain access or update permissions, contact Enterprise Application & System Entitlements (EASE).

Creating an API ID

Create API ID

To Create an API ID:

Select the User icon; select My Profile.

From the Profile page, select APIs from the menu.

Select Create API ID, then select the password Type: (Basic or OAuth).

API IDs must be unique at the firm level.

Create a Basic Auth API

Select Basic Auth then provide the following information. To confirm the authentication type refer to the applicable API message specification.

API ID: The API ID is required, case sensitive, must begin with the prefix API_ and must not already be registered to another customer. It does not need to be the same as the CME Group Login. An API ID that is not used for several months is automatically deleted.

Generate Password: Use a system generated password (maximum 24 characters) that complies with CME Group security requirements.

Use the Copy function to use the password for system setup and / or copy to a secure location.

Select Create API ID.

The password must be copied before this button is available.

Create an OAuth API

Select OAuth and provide information in the fields. Please refer to the applicable API message specification, on the CME Group Client Systems wiki, to confirm the necessary authentication type.

API ID: The API ID is required, must begin with the prefix API_ and must not already be registered to another customer. It does not need to be the same as the CME Group Login. An API ID that is not used for several months is automatically deleted.

Note: OAuth API IDs are case sensitive.

Select Generate Password and make a note of this for your usage.

Use the copy function to use the password for system setup and / or copy to a secure location.

Select Create API ID.

After successful setup, a confirmation message appears and the API ID appears in the table.

Managing API IDs

On the API Management page, authorized users can view the Scope, generate passwords and convert basic API authentication to OAuth method.

Select the API ID to Claim, convert authentication from Basic to OAuth, generate a new password.

Claim API ID

To Claim an API ID:

Claiming an API ID makes an association with the currently logged in user. An API ID can only be associated with one login profile.

From the API Management page select Claim API ID.
On the screen that appears, enter:

API ID: The API ID must begin with the prefix API_.
Password: Enter the password associated with the API ID being claimed.

Select Claim.

The API ID is validated and, if authorized, added to the table.

Convert API ID from Basic to OAuth

To Convert an API Authentication from Basic to OAuth:

From the API Management page, select an API ID with Basic authentication.

The Manage API ID screen appears.

Select the tab Convert to OAuth ID.
Select Generate Password, then Copy the password to a secure location.

Select Submit. Once the API ID is converted as an OAuth client ID, it will no longer work with the CME API services that only support Basic Authentication.

A security code is sent to the mobile phone number registered to the Profile.

Enter the code, then select Submit.

A confirmation message indicates successful conversion to OAuth.

Update API ID Password

To Update an API ID Password:

From the API Management table, select the API ID to manage.
Select the Update Password tab, then select Generate Password.

Copy the password and store in a secure location, then select Submit.

Confirm your identity by entering the code that was sent to the mobile phone number registered to the Profile, then select Submit.