Skip to main content

API Authentication

The Polinate API uses a simple header-based authentication system that requires two key pieces of information from your business settings. This guide will walk you through finding your credentials and implementing authentication in your requests.
All API requests must include both the Business ID and API Key headers for successful authentication.

Authentication Overview

Our API uses header-based authentication with two required headers:
  • X-Business-ID: Your unique business identifier
  • X-API-Key: Your secret API key for secure access

Finding Your Credentials

Your authentication credentials are located in your Polinate business settings. Follow these steps to locate them:
1

Navigate to Business Settings

Log into your Polinate dashboard at supplier.polinate.ai and navigate to your business settings.
2

Access the Integrations Section

In the business settings, look for the Integrations section in the sidebar or main navigation.
3

Copy Your Credentials

You’ll find two important values:
  • Business ID: A unique identifier for your business
  • API Key: A secret key used for authentication
Keep your API Key secure and never share it publicly. Treat it like a password.
Screenshot showing the Business Settings page with the Integrations section highlighted, displaying Business ID and API Key fields

Location of Business ID and API Key in the Integrations section

Implementation Examples

Here’s how to include the authentication headers in your API requests:
curl -X GET "https://api.polinate.ai/v1/your-endpoint" \
  -H "X-Business-ID: your-business-id-here" \
  -H "X-API-Key: your-api-key-here" \
  -H "Content-Type: application/json"

Authentication Headers Reference

X-Business-ID
string
required
Your unique business identifier found in the Integrations section of your business settings.Example: bus_1234567890abcdef
X-API-Key
string
required
Your secret API key for authentication. This key should be kept secure and never exposed in client-side code.Example: 1234567890abcdef1234567890abcdef

Error Response

Authentication errors return the following response when the provided headers are missing, invalid, or do not match your business credentials:
{
  "errorCode": "UNAUTHORIZED",
  "message": "Unauthorized",
  "requestId": "{{requestId}}"
}
  • errorCode: Always UNAUTHORIZED for authentication failures.
  • message: A human-readable description of the error.
  • requestId: An identifier for the request, useful when contacting support.

Troubleshooting

Make sure you’re logged into the correct account at supplier.polinate.ai. Navigate to Business Settings → Integrations. If you still can’t find them, contact our support team.
Double-check that:
  • Both X-Business-ID and X-API-Key headers are included
  • The header names are spelled correctly (case-sensitive)
  • You’re using the correct values from your business settings
  • Your API key hasn’t expired or been revoked
Need help? Contact our support team at [email protected] or join our slack.