Before you can access commerce data from customers using Clover, you need to set up the integration. You'll need to:
- Create an app in the Clover developer portal and retrieve your secure credentials (API key and secret).
- Log in to the Codat Portal.
- Add your secure credentials to the Codat Portal and enable your Clover integration.
- Check your data type settings.
Developer account details
If you already have a Clover developer account, have your account details to hand.
If you don't, sign up to the Clover developer portal before you start to create your application. Note that Clover's market currently covers many geographic regions and each is assigned a different domain. Create your developer portal by choosing your geographic area first:
If you require a Clover sandbox for testing purposes, sign up to the Clover Sandbox developer portal before you start to create your application
Go to the Clover developer portal and log in to your account.
Select Create App to create an app and get API credentials.
Fill in the required details for your app:
- Under Requested Permissions, tick "Read" for Customers, Inventory, Merchant, Orders, and Payments.
- Set the App type to Web.
- Under REST Configuration enter
You'll be taken to your API credentials page with App ID and secret generated. Keep this page open so you can retrieve your API keys in the next step.
Sign in to the Codat Portal.
On the navigation bar, select Settings > Commerce.
Find Clover and select the Manage button next to it to access its Integration settings page.
Choose what type of access to company data you wish to have for this integration: one-off or continuous.
From the API keys page on the Clover developer portal, copy and paste:
- App ID value into Client Id
- App secret value into Client Secret.
In the Codat Portal, click Save.
Go back to Settings > Commerce, and use the toggle to update the Clover integration from Disabled to Enabled. You can also enable this integration directly from its Integration settings page.
If this is your first commerce integration, update your data type settings to enable commerce data types.
You're now ready to test your Clover integration, or skip straight to setting up companies for your customers in the Codat Portal.
Updated 2 days ago