Manage API clients
Updated May 31, 20261 min read
Required roles:
AdminIT Manager
Stub page, the structure below outlines what the finished page will cover.
Use API clients to create OAuth client apps for integrations that consume the Carriyo API. Each client app has its own credentials and can be scoped to specific permissions.
Creating an API client
- Dashboard path: Settings > Integration > API Access > Client Applications (sub-tab at
/settings/api-access/clients). - Step 1: Navigate to the API Clients tab.
- Step 2: Click + add client.
- Step 3: Name the client and configure its scope (merchants, locations, allowed operations).
- Step 4: Save. Copy the client ID and secret, the secret is shown only once.
Managing existing clients
- Rotate the client secret.
- Activate or deactivate clients.
- Revoke a client to immediately disable its access.
- Review usage in the Integration Monitor.