To access the Connect API, you will need to create API credentials. These are obtained through creating a 'Connect connector' in our onboarding process. You can create multiple Connect connectors in one account.
It's recommended to create separate API credentials for any application you are connecting to the API.
- Step 1 – Selecting the connector
- Step 2 – Preset
- Step 3 – Authentication
- Step 4 – Connector
- Step 5 – Billing information
- Step 6 – Summary
- Step 7 – Confirmation
Step 1 – Selecting the connector
When logging into Connect, click the New connector button on the dashboard. This will open the onboarding wizard.
Select the Connect connector from the list of available connectors.
Step 2 – Preset
Select the option Configure connector manually, and click Next.
Step 3 – Authentication
This step will create the API credentials for Connect. Click Next.
Step 4 – Connector
Give your connector a name. It's common to relate the name to the system you will be using these credentials for, i.e. 'Connect API keys for CustomCRM'. Click Next.
Step 5 – Billing information
To continue, fill out any remaining billing information. This step may automatically be skipped if all information has been filled out previously. Click Next.
Step 6 – Summary
A summary of the selected preset for the integration will be displayed. Click Next.
Step 7 – Confirmation
This is the final step before the connector is activated. Once Confirm is clicked, the API credentials will be generated.
To retrieve the API credentials, navigate back to your dashboard. Click on the Connect tile (with the name you gave the connector in Step 4). Navigate to Advanced configuration below the common settings. There, the credentials are displayed.