Set up an OAuth 2.0 HTTP connection to Clover

Stephen Brandt

Updated November 22, 2024 11:04

Clover documentation: API guide , Authentication

A. Set up an HTTP connection

Start establishing an HTTP connection to Clover in either of the following ways:

From the Resources menu, select Connections. Then, click + Create connection at the top right.

– or –
While working in a new or existing integration, you can add an application to a flow simply by clicking Add source or Add destination/lookup.

In the resulting Application list, select HTTP.

The Create connection pane opens with required and advanced settings.

B. Edit HTTP application details

Note

This article is concerned only with the settings needed for Clover connections. For complete field documentation, see Set up an OAuth 2.0 HTTP connection.

Base URI: Enter one of the following values, depending on the Clover account instance you’re connecting to:

Sandbox: https://apisandbox.dev.clover.com
Production: https://www.clover.com

Media type: Accept the default value, JSON.

C. Configure auth settings

Continuing in the Create connection pane, select OAuth 2.0 for the Authentication type. The settings then become specific to OAuth 2.0 connections:

Grant type: Select Authorization code, as required by Clover.

iClient: Assuming you haven’t yet established a Clover iClient (token ID-secret pair), click the + button to create one . Enter an identifiable Name along with the Client ID and Client secret from your Clover account. Click Save & close to add the iClient to your integrator.io account and select it for this connection.

Authentication URL: Enter one of the following values, depending on the Clover account instance you’re connecting to:

Sandbox: https://sandbox.dev.clover.com/oauth/authorize
Production: https://www.clover.com/oauth/authorize

Access token URL: Enter one of the following values, depending on the Clover account instance you’re connecting to:

Sandbox: https://sandbox.dev.clover.com/oauth/token
Production: https://www.clover.com/oauth/token

Client authentication: Select Send client credentials in body.

Location: Select Header.

Header name: Accept the default value, Authorization.

Scheme: Select Bearer.

Set up a Clover app and retrieve connection info

First, sign in to your Clover production or sandbox web dashboard, and go directly to your developer account:

Sandbox login shown; app requires developer account

On the homepage of your developer dashboard, click Create app:

Name the new app, set its regions, and click Create:

Copy the App ID and App secret from the resulting app for your connection’s iClient pair.

Then, click to edit the App type:

Choose REST clients > Web and click Save:

Now that you have a REST API app, you can edit its settings:

Enter the Callback URL, above, for the Clover app’s Site URL and click Save:

D. Specify How to test this connection?

Ping relative URI: Enter /v3/merchants/{{connection.http.unencrypted.MerchantID}}/customers. The unencrypted MerchantID handlebars value will be provided below, in the Advanced settings.

Ping method: Select GET for Clover OAuth 2.0 connections.

E. Provide Advanced settings

Unencrypted: Enter the JSON format of your merchant ID, for example

{"MerchantID" : "0123456789"}.

Retrieve your Clover account Merchant ID

Sign in to your Clover account (or return to the Businesses dashboard, if you were still signed in at the Developer dashboard from earlier).
From the Setup menu, select Merchants.
Copy the ID shown (masked below as NH•••••••••G1).

F. Save, test, and authorize

Once you have configured the HTTP connection, you have a few options for continuing:

Save & authorize – click this button to test the connection, commit the new connection so that it will be available to all integrations for your account (and applied to the current source or destination app, if you created it within a flow)
Cancel – click this link to exit connection creation without saving
Test connection – click this button to verify that your new connection is free of errors

When you test or save the connection, it is verified before continuing.

If the connection fails, double-check the provided settings, and test again.

G. Integrate with Clover

Then, when creating a flow step (such as an export, import, or lookup) to Clover, start by selecting an HTTP application, and then choose your Clover connection for it.