Use Clover REST API
Clover provides its REST API at a separate base URL in the production environment for each of its supported markets.
- United States and Canada:
https://api.clover.com
- Europe:
https://api.eu.clover.com
- Latin America:
https://api.la.clover.com
While building and testing your apps in the sandbox environment, use the sandbox REST API with the Android emulator or with our Developer Kits and sandbox test merchants:
https://apisandbox.dev.clover.com
You can find a list of supported endpoints in Clover's REST API Reference. These endpoints accept query parameters in the following format:
[Endpoint URI]?field=value[,additionalValues...]&[additionalQueryStrings...]
Sample REST API requests
To retrieve information about your test merchant, send a GET
request to /v3/merchants/mId
:
curl --request GET \
--url https://apisandbox.dev.clover.com/v3/merchants/{mId} \
--header 'accept: application/json' \
--header 'authorization: Bearer {auth_token}'
To update the test merchant name, send a POST
request to /v3/merchants/mId`:
curl --request POST \
--url https://apisandbox.dev.clover.com/v3/merchants/{mId} \
--header 'accept: application/json' \
--header 'authorization: Bearer {auth_token}'
--data '{"name":"{updated_merchant_name}"}'
In both requests, mId
is the test merchant UUID and auth_token
is the API token (or access token). See Test merchant IDs & API tokens for more information.
Here is some key information about the Clover REST API:
- HTTPS: Clover's API is only accessible through HTTPS
- JSON: Request and response entities are in JSON
- OAuth: All API requests in production are protected by an OAuth2-derived access token. See Using OAuth 2.0 for more information.
- Permissions: Using Clover API endpoints requires access to necessary permissions. See Platform API permissions and E-Commerce API permissions for more information.
Updated about 1 month ago