Clover uses the industry-standard OAuth 2.0 protocol for authentication. Generating an API token is a fundamental part of the OAuth flow to enable secure, controlled, and auditable access to APIs. Use API tokens to:

• Authenticate requests to Clover REST APIs. Use the merchant-specific API token as the Bearer token to make calls to the Clover Platform API endpoints. See API Reference > Platform API section.
• Secure the communication between an app integration and your merchant account.
• Allow an app to access and create merchant data, such as payments, orders, and inventory.

View and create a merchant-specific API token

1. Access the Settings page on the Merchant Dashboard.

2. In the Business Operations section, click API tokens. A Welcome to Clover API Tokens pop-up appears.

   

3. Review the information and click Get Started. The URL wants to Know your Location pop-up appears.

4. Click Allow to let the dashboard access your location. The API Tokens page appears.

   • If you have previously generated an API token, it displays on the page. You can create as many merchant-specific test API tokens as required.
   • If you have not created any API tokens, the Tokens section on the page is blank.

5. Click Create new token. The Create new token pop-up displays app permissions that map to platform API endpoints.
6. Enter a token name.
7. Select checkboxes to set permissions based on the test merchant information you want to manage. API tokens are scoped to grant specific permissions to make sure that apps only have access to the resources they need.

8. Click Create Token. The new token displays in the Tokens section.

9. Expand the Permissions section to view or edit the permissions associated with the API token.

Related topics

• Authenticate with the v2/OAuth flow
• Manage test merchant accounts and information