Essentials

Authentication

Every Core API request is authorized by a scoped API key. Treat that key like a password.

Send an API key

Use the X-API-Key header for new integrations. Bearer authentication is supported when a client cannot set a custom header.

PreferredX-API-KeyX-API-Key: $PRICEMIND_API_KEY
AlternativeBearer tokenAuthorization: Bearer $PRICEMIND_API_KEY
Preferred header
curl https://api.pricemind.io/v1/me \
  --header "X-API-Key: $PRICEMIND_API_KEY"

Scopes and capabilities

Channel catalog reads use products:read. Include matched offers with the additional competitor_prices:read scope; all offer routes require both. Existing keys do not inherit new scopes. Issue a uniquely named replacement key, switch and verify your client, then revoke the old key.

Keys expose only the operations granted to them. A request without the required scope returns 403 Forbidden and the denied operation ID.

Least privilege

Grant only the scopes an integration needs.

Runtime truth

Use /v1/me and /v1/capabilities to inspect effective access.

Key safety

  • Store keys in a secret manager or server-side environment variable.
  • Use separate keys for production, staging, and each external integration.
  • Rotate a key immediately if it appears in logs, source control, or client-side code.
  • Use optional IP allowlists for workloads with stable egress addresses.
Never log the full key

A key includes both an identifier and a secret. Redact the entire value in request logs and support artifacts.

Authentication errors

401Missing or invalid keyCheck the header and make sure the key is active.
403Restricted or insufficient scopeCheck IP rules and the operation's required permission.
429Hourly limit reachedHonor Retry-After and retry with backoff.