Manage API Keys

API keys allow you to generate an authentication credential that is separate from your Monetate username and password. If you want to set up an integration between your Monetate account and your applications or servers, you need to generate unique API users and then create public keys that can you can revoke if needed.

To ensure secure communication, Monetate uses public/private key pairs. Public keys are made available to everyone while private keys remain confidential to their respective owners. Whatever is encrypted with a public key may only be decrypted via the corresponding private key and vice versa.

Accessing API Keys

Follow these steps to access API keys stored in the Monetate platform.

  1. Click the settings icon and then click Sites.

    Callout of the Sites option in the settings menu

  2. Click the API Keys tab.

    Callout of the 'API Keys' tab on the Sites page

Creating an API User

Follow these steps to create an API user in the Monetate platform.

  1. Click CREATE API USER.

    Callout of the 'CREATE API USER' button on the 'API Keys' tab of the Sites page

  2. Enter a unique username into the required text input field.

    Callout of the Name field on the 'Create API User' modal

  3. Select the user type.

    Callout of the 'API User' and 'Read-Only API User' options on the 'Create API User' modal

  4. Click CREATE.

    Callout of the CREATE button on the 'Create API User' modal

Public Key Requirements

Monetate only accepts public keys in PEM format. You must store keys as Base64-encoded text between the following markers:

-----BEGIN PUBLIC KEY----- and -----END PUBLIC KEY-----.

Monetate ignores any text outside of the begin and end markers.

Base64 text consists of only uppercase and lowercase Roman alphabet characters (A-Z, a-z), numerals (0-9), and the plus sign (+) and forward slash (/) symbols.

The following is a sample of a PEM-formatted public key:

-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAjvPD6i+bdp2bIp1xjbWO
duRuiSOQi9MsKTuYk4QvKlT/kGMrTCeGo0LpqzzRtznWPziWrQNo3lTdAn5TpCQz
VJ4Zm5PswkkBeVnOZKNnZndSdHH2V9NJPlL6u8ytUuYaXaqbdT7Ow/lNwicPuzIU
uuw53hZd10OZlcI7OUodZHqK7TSHe+6eF6gUfEeMMk9hKeDTqDSvkCFdKMe57YLG
TQSUc1JWjDo505xOzpBzMJMjBUcqmAjFPFch9te+rW6NvD9R7XMb2ccE8MoIc3zv
DzE4qp1a1w1EayFSAsAQ89q8AFxGENxVCPuo5k3VHAGKKwqvctoVCwLJB0iE6Kvx
0wIDAQAB
-----END PUBLIC KEY-----

For additional details about building your own Monetate integration, consult the Auth API documentation in the Monetate Developer Hub.

Adding a Public Key

Follow these steps to add a public key for an API user in the Monetate platform.

  1. Select a user from the list on the left, and then click CREATE PUBLIC KEY.

    Callout of the 'CREATE PUBLIC KEY' button on the 'API Keys' tab of the Sites page

  2. Paste a PEM-formatted public key into the required text area input field.

    Callout of the Public Key field on the Public Key Details modal

  3. Click SAVE.

    Callout of the SAVE button on the 'Public Key Details' modal

Viewing Full Public Keys

Follow these steps to view the full public key for an API user in the Monetate platform.

  1. Select the user from the list on the left.
  2. Click the additional options menu (...) for the key that you want to view, and then select View Full Key.

    Callout of the additional options menu and the 'View Full Key' option

The details appear in a modal.

The 'Public Key Details' modal

You cannot edit a public key once you activate it. You must revoke the key and then add a new one.

Revoking a Public Key

Once you revoke a public key, you cannot restore it.

Click the additional options menu (...) for the key you want to revoke, and then select Revoke.

Callout of the Revoke option in the additional options menu

Related Articles