API Keys

Overview

Engage+ supports a wide range of APIs that can be used to create or edit different Asset types, to request information about Assets, to submit data to be loaded into your database, and to trigger the launch and deployment of a marketing Campaign.

Within the platform, authentication for APIs is handled by an open standard protocol called OAuth 2.0. This protocol was designed specifically for HTTP, and provides standard mechanisms to allow the platform's API users to request access to a particular service.

Authentication with OAuth 2.0 requires you to obtain a "Consumer Key" and a "Consumer Secret." The Consumer Key is analogous to a username, and is considered public information; the Consumer Secret is analogous to a password, and is kept confidential. Both of these pieces are managed at the user level, and can be obtained from the API Keys screen.

The Consumer Key and Consumer Secret are used to request a "token." A token is a text string that, when provided in a request message, will allow the user access to the requested service. To get a token, you must provide your credentials (the Consumer Key and Secret) directly to the authentication server via a POST request. If these credentials are valid, the server replies back with the token. With this token now in hand, you are now fully authenticated, and you can begin making API service calls to the platform.

Access

The API Keys screen is accessible by the following method:

From the Main menu, select Data > Management > API Keys

Features

The primary purpose of the API Keys screen is informational -- you can view your Consumer Key and Consumer Secret so that you can integrate these values into your API token request message. This screen also displays usage statistics, such as the total number and average number of API requests you've sent over several different time periods (past hour, past day, etc.).

If you ever need to reset or update your Consumer Secret:

Click regenerate secret. The system generates a new Consumer Secret, and displays it on the screen