aria-partner-api

Authentication

Partner API access uses an API key issued in the admin dashboard. Send it as a Bearer token on every request.

See Partner endpoint for partner metadata and Account API for accounts and members once authenticated. For web-based onboarding, billing, and usage views, see Admin dashboard.

Admin URL: https://my.kanary.com/dashboard/settings/admin

Typical flow:

  1. Sign in to the admin dashboard and open API settings.
  2. Create or copy your organization’s API key.
  3. Send Authorization: Bearer <api_key> on every Partner API request.
  4. Revoke the key if necessary
  5. Expiration and rotation on schedule or forced

Store the key in a secrets manager or environment variable. Do not commit it to source control.

Onboarding checklist

  1. Partner record: provisioned when you set up an admin account for your organization.
  2. API access: request API access in the dashboard; Kanary approves and enables API settings.
  3. Billing: payment configured on the partner record.
  4. Activation: Kanary sets account as active after billing is confirmed.
  5. API key: copy the key from the admin dashboard API settings.
  6. Integrate: Authorization: Bearer <api_key> on every Partner API request.

Sandbox access and production go-live are arranged through your Kanary partnership contact.

Authorization: Bearer <api_key>
Content-Type: application/json

Errors on protected routes

Status Condition
401 Missing, invalid, or revoked API key
403 Valid key but partner is not active, or caller not authorized

Key lifetime and rotation

Setting Value
Lifetime Does not expire by default; contact us to adjust according to organizational policies

Using keys on Partner API routes

Requirement Detail
Header Authorization: Bearer <api_key>
Partner scope Key must belong to your organization’s partner record
Active partner Must be true