Authentication - Pro Convey API

Our API uses bearer token authentication to secure your requests.

Bearer Token Authentication

Bearer tokens provide a straightforward way to authenticate API requests. Include your token in the Authorization header of each request.

Getting your bearer token

Log into your dashboard
Navigate to Settings > Integrations
Generate a new API key
Copy and securely store your token

Keep your API keys secure and never expose them in client-side code or public repositories.

Using bearer tokens

Include your bearer token in the Authorization header:

curl -X GET 'https://yourorg.proconvey.co.uk/api/v2/cases' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://yourorg.proconvey.co.uk/api/v2/cases', {
  headers: {
    'Authorization': `Bearer ${process.env.API_TOKEN}`
  }
});

import requests

headers = {
    'Authorization': f'Bearer {api_token}'
}
response = requests.get('https://yourorg.proconvey.co.uk/api/v2/cases', headers=headers)

Error handling

Common authentication errors and how to handle them:

401 Unauthorized

Cause: Invalid or missing authentication credentialsSolution: Verify your API key is correct and included in the Authorization header

403 Forbidden

Cause: Valid credentials but insufficient permissionsSolution: Check that your API key has the required scopes for the endpoint

Best practices

Store API keys securely using environment variables or a secrets manager
Use the minimum required scopes for your integration
Regularly rotate your API keys
Never expose keys in client-side code or version control

Testing authentication

You can test your authentication setup by making a request to the organisation endpoint:

curl -X GET 'https://yourorg.proconvey.co.uk/api/v2/org' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

A successful response confirms your authentication is working and returns your organisation details.

API Documentation Creating a Case

​Bearer Token Authentication

​Getting your bearer token

​Using bearer tokens

​Error handling

​Best practices

​Testing authentication

Bearer Token Authentication

Getting your bearer token

Using bearer tokens

Error handling

Best practices

Testing authentication