Overview

The Ecommerce API key is required to complete the OAuth flow for using the Clover Ecommerce API. This key is provided by the Public Access Key Management Service (PAKMS) and is also known as the apiAccessKey. It is unique to each merchant and does not expire. You need to send a request to the PAKMS endpoint only once for each merchant when they first install and configure your app. Your app should store the returned Ecommerce API key for use in each of that merchant’s subsequent card tokenization. See the Ecommerce - PAKMS API reference for more information.

🚧

IMPORTANT

Clover reserves the right to disable keys suspected of misuse and violation of our terms. If needed, you can send an email to: [email protected]to request the deactivation of an Ecommerce API key.

Generate an Ecommerce API key

1. Generate an OAuth API token or access_token.
2. Send a GET request to the https://scl-sandbox.dev.clover.com/pakms/apikey endpoint.
3. Set the authorization: Bearer as your OAuth-generated access_token from step 1.

In response, the Clover server returns an apiAccessKey, which is the Ecommerce API key or PAKMS key. You can use theapiAccessKey as the apikey header when you tokenize a card.

Request and Response example—Ecommerce API or PAKMS apiAccessKey

curl --request GET \
--url 'https://scl-sandbox.dev.clover.com/pakms/apikey' \
--header 'Authorization: Bearer {access_token}'

{
  "active": true,
  "apiAccessKey": "af4exxxxxxxxxxxxxxxxxxxxxxxxd145",
  "createdTime": 1722230745532,
  "developerAppUuid": "RKxxxxxxxxx9C",
  "merchantUuid": "6Xxxxxxxxxx91",
  "modifiedTime": 1722230745532
}

Related topics

• Ecommerce PAKMS API: Retrieve an Ecommerce API key endpoint.
• Card tokenization service API: Create a card token endpoint.
• Ecommerce API Reference for additional steps to work with charges, customers, orders, refunds, and more.
• Blog: Fiddling Through Digital Keys: Clover Auth Tokens and Ecommerce Keys