API Authentication

Our API uses API Key authentication to ensure secure access. Only Admin users can generate API keys, while Member users do not have permission to create or manage keys. This ensures that only authorized users can access and integrate the API.

Generating an API Key

To obtain an API key:

1. Navigate to Settings in the UI.

2. Go to the API Keys section.

3. Click + Add.

4. Input a label for the key, optionally set an expiration date and click Add Key.

5. Copy and securely store the key, as it will not be shown again.

API Keys settings section

Using the API Key

Once you have generated an API key, include it in the request header for authentication:

X-API-Key: YOUR_API_KEY

Example request using curl:

curl -X GET "https://partner.aboutyou.com/api/v1/products" \
     -H "X-API-Key: YOUR_API_KEY"