Overview
To authenticate with Conveyor, you need:
- API Key — a Conveyor API key.
This guide will show you how to create one.
Prerequisites
- A Conveyor account whose plan includes the public API. See Conveyor pricing to talk to sales.
- A user in a Superadmin or Conveyor Admin role, or in a custom role that has the Integrations module granted at an Admin level.
Step 1: Create an API key
- Log in to Conveyor.
- Click the dropdown in the top right, select Settings, then open the Integrations tab. You can also go directly to app.conveyor.com/settings/organization/integrations.
- Click Add Integration in the top right.
- Choose Conveyor API at the bottom of the list and click Next Step.
- Enter a name for the API key, select the permissions your integration needs, and click Create.
- Copy the key, then click Done.
Conveyor shows the full key only once. Store it securely; if you lose it, create a new one.
Step 2: Enter your API key in the Connect UI
- Open the form where you need to authenticate with Conveyor.
- Enter your key in the API Key field.
- Submit the form. The connection is saved without checking the key: if the key is wrong, the first API request returns an authentication error.
You are now connected to Conveyor.
