The Clover REST API lets you query relevant information about Clover merchants in your web app. Relevant information, such as merchant inventory, orders, and payments, is available using our REST API. An endpoint represents each type of merchant information.

Use the Android emulator or Developer Kits in the sandbox environment for building and testing your apps with test merchants. For your Android app, you can generate an API token and query web services using the Clover Android SDK.

Use the following procedure to make a sample API call using the Clover API Reference.

Use the API Reference

Prerequisites

To use the Clover platform API, you require the following:

• Sandbox developer account
• Test merchant account
• Test API token with permissions to make REST API requests and manage your test merchant's data.

Make a sample REST API call

To make a sample REST API call using the Clover API reference:

1. From the Platform API left navigation, select MERCHANTS > Get a single merchant.
2. Set the Authorization header as Bearer token type, and enter the test API token you generated in the sandbox Developer Dashboard.
3. In the Path Params section, enter your test merchantId in the mId field. Your test merchant ID is a 13-alphanumeric identifier that displays in the browser link (URL) of the Merchant Dashboard for your test merchant. See Locate your test merchant ID.
4. Click Try It. In the JSON output response, the name value is your test merchant’s name.

Test Rest API calls with the sample inventory

1. Use the sample inventory file to test more REST API calls for your test merchant.
2. On the Merchant Dashboard, select the Inventory app, and then follow the instructions to upload the sample inventory file. See Import inventory.

Related topics

• Use the Clover REST API
• Generate a merchant-specific test API token
• Use test merchant identifier and API token
• Redirect merchants to your app