Clover Authenticate a Connector

You can authenticate with Clover to create your own instance of the Clover connector through the UI or through APIs. Once authenticated, you can use the connector instance to access the different functionality offered by the Clover platform.

Authenticate Through UI

Use the UI to authenticate with Clover and create a connector instance. Because you authenticate with Clover via OAuth 2.0, all you need to do is add a name for the instance and the provider the credentials you identified in Clover API Provider Setup. After you create the instance, you'll log in to Clover to authorize Axway AMPLIFY access to your account. For more information about authenticating a connector instance, see Authenticate a Connector Instance (UI)

After successfully authenticating, we give you several options for next steps. Make requests using the API docs associated with the instance, map the instance to a virtual data resource, or use it in a formula template.

Authenticate Through API

Authenticating through API is similar to authenticating via the UI. Instead of clicking and typing through a series of buttons, text boxes, and menus, you will instead send a request to our /instances endpoint. The end result is the same, though: an authenticated connector instance with a token and id.

Authenticating through API follows a multi-step OAuth 2.0 process that involves:

  • Getting a redirect URL. This URL sends users to the vendor to log in to their account.
  • Authenticating users and receiving the authorization grant code. After the user logs in, the vendor makes a callback to the specified URL with an authorization grant code.
  • Authenticating the connector instance. Using the authorization code from the vendor, authenticate with the vendor to create a connector instance at Axway AMPLIFY.

Getting a Redirect URL

Use the following API call to request a redirect URL where the user can authenticate with the service provider. Replace {keyOrId} with the connector key, clover.

curl -X GET /elements/{keyOrId}/oauth/url?apiKey=<Clover App ID>&apiSecret=<Clover App Secret> &callbackUrl=<Clover Site URL>&merchantId=<Clover Merchant ID>

Query Parameters

Query Parameter Description
apiKey The API key or client ID obtained from registering your app with the provider. This is the App ID that you recorded in the API Provider Setup section.
apiSecret The client secret obtained from registering your app with the API provider. This is the App Secret that you recorded in the API Provider Setup section.
callbackUrl The URL that the API provider returns a user to after they authorize access. This is the Site URL that you recorded in the API Provider Setup section.
Merchant ID The Merchant ID that you recorded in the API Provider Setup section.

Example cURL

curl -X GET \
'https://api.cloud-elements.com/elements/api-v2//elements/clover/oauth/url?apiKey=Rand0MAP1-key&apiSecret=fak3AP1-s3Cr3t&callbackUrl=https:%3A%2F%2Fwww.mycoolapp.com%2auth&merchantId=5HBxxxxxxxxxxxxx' \

Example Response

Use the oauthUrl in the response to allow users to authenticate with the vendor.

{
"oauthUrl": "https://clover.com/oauth/authorize?client_id=Rand0MAP1-key&merchant_id=5HBxxxxxxxxxxxx",
"element": "clover"
}

Authenticating Users and Receiving the Authorization Grant Code

Provide the response from the previous step to the users. After they authenticate, Clover provides the following information in the response, where code is the primary information required for the next step:

  • state
  • code
  • merchant_id
  • employee_id
  • client_id
Response Parameter Description
code The authorization grant code returned from the API provider in an OAuth 2.0 authentication workflow. Axway AMPLIFY uses the code to retrieve the OAuth access and refresh tokens from the endpoint.
state A customizable identifier, typically the connector key (clover).
merchant_id, employee_id, client_id Additional identifiers related to the request.
Icon

If the user denies authentication and/or authorization, there will be a query string parameter called error instead of the code parameter. In this case, your application can handle the error gracefully.

Authenticating the Connector Instance

Use the /instances endpoint to authenticate with Clover and create a connector instance. If you are configuring events, see the Events section.

Icon

The endpoint returns a connector instance token and id upon successful completion. Retain the token and id for all subsequent requests involving this connector instance.

To authenticate a connector instance:

  1. Construct a JSON body as shown below (see parameters):

    {
      "element": {
        "key": "clover"
      },
      "providerData": {
        "code": ""
      },
      "configuration": {
        "oauth.api.key": "",
        "oauth.api.secret": "",
        "oauth.callback.url": "",
        "clover.sandbox": "",
        "merchantId": ""
      },
      "tags": [
        ""
      ],
      "name": ""
    }
    
  2. Call the following, including the JSON body you constructed in the previous step:

    POST /instances
    Icon

    Make sure that you include the User and Organization keys in the header. For more information, see Authorization Headers, Organization Secret, and User Secret.

  3. Locate the token and id in the response and save them for all future requests using the connector instance.

Example cURL

curl -X POST \
  https://api.cloud-elements.com/elements/api-v2//instances \
  -H 'authorization: User , Organization ' \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "clover"
  },
  "providerData": {
    "code": "xxxxxxxxxxxxxxxxxxxxxxx"
  },
  "configuration": {
    "oauth.callback.url": "https;//mycoolapp.com",
    "oauth.api.key": "Rand0MAP1-key",
    "oauth.api.secret": "fak3AP1-s3Cr3t",
    "clover.sandbox": "false",
    "merchantId": "5HBxxxxxxxxxxxx"
  },
  "tags": [
    "Docs"
  ],
  "name": "API Instance"
}'

Parameters

API parameters not shown in Axway AMPLIFY are in code formatting.

Icon

Event-related parameters are described in Events.

Parameter Description Data Type
key The connector key.
clover
string
code The authorization grant code returned from the API provider in an OAuth 2.0 authentication workflow. Axway AMPLIFY uses the code to retrieve the OAuth access and refresh tokens from the endpoint. string
Name
name
The name of the connector instance created during authentication. string
OAuth API Key
oauth.api.key
The API key or client ID obtained from registering your app with the provider. This is the App ID that you noted in the API Provider Setup section. string
OAuth API Secret
oauth.api.secret
The client secret obtained from registering your app with the API provider. This is the App Secret that you noted in the API Provider Setup section. string
OAuth Callback URL
oauth.callback.url
The API key or client ID obtained from registering your app with the provider. This is the Site URL that you noted in the API Provider Setup section. string
Sandbox
clover.sandbox
For connecting to an app on a Clover Sandbox server select True. Otherwise, keep the default False. boolean
Merchant ID
merchantId
The Merchant ID that you recorded in the API Provider Setup section. string
tags Optional. User-defined tags to further identify the instance. string

Example Response for an Authenticated Connector Instance

In this example, the instance ID is 12345 and the instance token starts with "ABC/D...". The actual values returned to you will be unique: make sure you save them for future requests to this new instance.

{
  "id": 12345,
  "name": "Instance via API",
  "createdDate": "2017-11-30T21:53:35Z",
  "token": "ABC/D...xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "element": {
      "id": 5217,
      "name": "Clover",
      "hookName": "Clover",
      "key": "clover",
      "description": "Add a Clover Instance to connect your existing Clover account to the Employees Hub, allowing you to manage roles, timesheets, employees, and so forth across multiple Employee Connectors. You will need your Clover account information to add an instance.",
      "image": "elements/custom-element-default-logo.png",
      "active": true,
      "deleted": false,
      "typeOauth": false,
      "trialAccount": false,
      "resources": [ ],
      "transformationsEnabled": true,
      "bulkDownloadEnabled": true,
      "bulkUploadEnabled": true,
      "cloneable": true,
      "extendable": false,
      "beta": false,
      "authentication": {
          "type": "oauth2"
      },
      "extended": false,
      "hub": "employee",
      "protocolType": "http",
      "parameters": [  ],
      "private": false
    },
    "elementId": 5217,
    "tags": [
        "Docs"
    ],
    "provisionInteractions": [],
    "valid": true,
    "disabled": false,
    "maxCacheSize": 0,
    "cacheTimeToLive": 0,
    "providerData": {
        "code": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    },
    "configuration": {    },
    "eventsEnabled": false,
    "traceLoggingEnabled": false,
    "cachingEnabled": false,
    "externalAuthentication": "none",
    "user": {
        "id": 123456,
        "emailAddress": "claude.elements@cloud-elements.com",
        "firstName": "Claude",
        "lastName": "Elements"
    }
}

Related Links