Authentication

Authentication reference for the ixblix API.

API Key Authentication

All company-scoped endpoints require the X-API-Key header:

Header
X-API-Key: smci_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Obtaining an API Key

API keys are generated during company activation. See Company Registration.

Integrator Authentication

Integrator-scoped endpoints use HTTP Basic Auth with integratorId and accessToken:

cURL
curl https://api.ixblix.app/api/plans \
  -u "int_xxxx:ixblix_integrator_token_xxxx"

Contact (Customer) Authentication

Customer-facing endpoints use the conversation token (from the deeplink) instead of an API key. No authentication header is needed — the token is included in the request body or URL path.

Security Recommendations

  • Store API keys in a secure secret manager, never in source control.
  • Rotate keys if they are exposed.
  • Use HTTPS for all requests.
  • The API key grants access to all company resources; treat it like a password.

Authentication Errors

StatusCodeMeaning
401UNAUTHORIZEDAPI key is missing or invalid.
403FORBIDDENCompany exists but is not active.