Making a REST API call

The Clover REST API enables you to query relevant information about Clover merchants in your Web app. Relevant information, such as merchant inventory, orders, and payments is available to you using our REST API. Each type of merchant information is represented by an endpoint.

👍

TIP

For your Android app, you can simply generate an API token and query web services using Clover Android SDK.

Making a REST API call

In this topic, we guide you to make a sample REST API call and retrieve your test merchant’s name.

To make a REST API call:

  1. Navigate to the API Reference.
  2. Under MERCHANTS > Get a single merchant, enter the Merchant Id value. This value is 13 characters in length and is found in the browser window URL of your test merchant dashboard.
  3. Select the Query Auth icon at the top-right next to the Try It button.
  4. Enter the access_token value. This value is the test API token that you generated in the sandbox Developer Dashboard.
  5. Click Try It. The output JSON of the API call is generated at the right of the screen. In the results, the value of the Name Key is your test merchant’s name.

For more information about the Clover REST API service, see Clover REST API. Use this sample inventory file to test more REST API calls for your test merchant. On the Merchant Dashboard, select the Inventory app and then follow the instructions to upload the sample inventory file.


Did this page help you?