Creating an API Key

March 26, 2020 Contributors

**Configuration Change. ** As of version 4.1, API authentication is enabled by default. For instructions to disable it, see Enforcing REST API/UI User Authentication . When disabled, an apikey and Authorization header is no longer required.

Introduction

Momentum offers a set of REST API enabling client applications to integrate with Momentum and perform actions associated with generating messages and reporting analytics data. To ensure security for your application, Momentum enforces API authentication by default. All REST APIs require that you authenticate with every request by specifying an Authorization header. The value of the Authorization header must be a valid API key with the appropriate permissions to use the API. For examples of supplying the Authorization header, refer to the cURL examples in the following sections or any of the individual REST API request examples in the Momentum 4 REST API documentation.

If you are the system administrator, you can generate an API key using the web-based UI.

Creating an API Key

This section provides instructions to create an API key in the UI. Take care to record and safeguard your API keys at all times. You cannot retrieve an API key after it has been created.

Note

For this tutorial, you will need a web browser to access the UI. The UI supports Firefox and Internet Explorer, version 9 and 10. All browsers must have cookies and JavaScript enabled.

You must also have system administration privileges.

Follow these steps to create an API key:

  1. Open the UI by pointing your web browser at the appropriate IP address and log in using your administrator credentials.

  2. Click admin in the upper-right corner, as shown in “Login”, to open the Settings section.

  3. In the Settings section, click the New API Key icon in the upper-right corner to open the Create New API Key form, as shown in “Create New API Key”.

  4. Enter the following information:

    • Label – User-friendly label for the API key

    • Account Password – Password for account to verify access

      Your password is required to securely authorize this addition to your account.

  5. Select the grant types that you want from the list displayed. It is always best practice to ONLY select the permissions that are necessary. To complete the examples in the following sections, you will need all grant types. For an explanation of the permissions, see “Viewing Your API Keys”.

  6. When complete, click Create to create your new API key. If the API key is successfully created, a message will display upon return to the Settings section showing the value of the API key.

  7. Record the value of your API key to use in the following tutorials.

    Note

    Be sure to copy and paste the API key when it is displayed. Following the creation of an API key, you can modify its grants and associated label, but the UI will no longer expose the original value. Please take care to record and safeguard your API keys at all times.

Congratulations! You have successfully created an API key using Momentum’s UI. In addition to the creating an API key, you can manage your existing API keys using the UI. For more information, see Managing Your API Keys .