API Keys (M)

Owned by Paul Clifton
Last updated: Sept 07, 2023
2 min read

The API Keys page contains a list of all API keys saved to your account and allows you to add a new API key or remove a saved key. An API Key is an authentication method that validates a user that is sending data to platform API (including both Merchant and other users).

Note: For more information about API keys, visit the What Is An API Key page.

Navigate to the API Keys page by clicking Settings in the left-hand navigation panel, and then clicking API Keys in the Business Settings section of the Settings page.

Partial view of the API Keys page, including the API Keys Table and the Add API Key button.

API Keys Features

API Keys Table

The API Keys table contains a list of all API Keys saved to your account, and includes the following information:

API Key Table Column Name

Description

API Key Table Column Name

Description

Name

The name of the API key.

Key

The alpha-numeric key sequence.

Created

The date that the key was created.

Active

Indicates whether the key is active. Choose from Active or Inactive.

Public

Indicates whether this is a public or private key. Choose from Public or Private.

Remove

To delete a key from your account, click the GREY X icon to open the Delete a Key lightbox. Confirm deleting the key by clicking CONFIRM, or return to the previous screen without deleting by clicking CANCEL.

Add API Key Button

The Add API Key button is located in the top right-hand corner of the page. To add a new API Key to your account, follow the steps below:

  • Step 1: Click the ADD API KEY button to open the Add API Key section at the top of the page.

  • Step 2: Enter the name of the new API Key.

  • Step 3: Set the API key status using the Status drop-down menu. Choose Active or Inactive.

  • Step 4: Set the type of key using the Type drop-down menu. Choose from Public or Private.

  • Step 5: Save your new key by clicking the ADD button below the API Key drop-down menus, or return to the previous page without saving by clicking CANCEL.

  • Step 6: The new API Key will now appear in the API Keys table, with the API Key alphanumeric code in the Key column.

Related Pages:

Click the items on the page or the links below to access any of the following pages: