CLclover
KEYS

Retrieve an Ecommerce API key or PAKMS key

**Prerequisite: **Generate an OAuth API token or access_token.

**Description: **Retrieves the public Ecommerce API key associated with a specific merchant and developer app. The <glossary:merchantId> and App ID are available in the OAuth API token or access_token.

**Tutorial: **Generate an Ecommerce API key (PAKMS key).

**Next step: **Use the Ecommerce API key for tokenization. See Ecommerce tokenization overview.

get/pakms/apikey

Request

  • Base URL
    https://scl-sandbox.dev.clover.com
  • URL
    https://scl-sandbox.dev.clover.com/pakms/apikey
  • Auth
    OAuth 2
    Authorization code: https://sandbox.dev.clover.com/oauth/authorize
    Token URL: https://sandbox.dev.clover.com/oauth/token

Query parameters

tokenAssociationGroupUuidstring

Universally unique identifier (UUID) of the token association group for this API key (reserved). See Clover Ecommerce basics.

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <application>/<version>

Response

Successful response. API key is displayed.

activeboolean

Indicates whether the API key is active. Values: True False

apiAccessKeystring

API key associated with the merchant and developer application.

createdTimeinteger nullable

Time when the API key was created.

developerAppUuidstring

Unique universal identifier (UUID) of the developer app.

merchantUuidstring

Unique universal identifier (UUID) of the merchant. Also known as merchant ID (mId).

tokenAssociationGroupUuidstring

Unique universal identifier (UUID) of the token association group.

modifiedTimeinteger nullable

Time when the API key was modified.

Changes

No recorded changes to this operation across all 1 revision of this API.