Claim your Partner Key

How to obtain the Partner Key that authorizes the Partner Core API.

A Partner Key authorizes calls to the Partner Core API, the API used to manage Devices, End Customers, and Tickets across a Partner Cloud. It identifies the caller as the Partner and carries that Partner's permissions.

Becoming a Partner

To register as an Xyte Partner and start connecting Devices to the cloud, email the Sales team at [email protected]. A Partner Cloud and a Partner Portal account are provisioned as part of onboarding.

Finding your Partner Key

Sign in to the Partner Portal and go to Settings → API Keys. Keys are created, named, and revoked there. A key is shown in full when it is created.

API access is gated by the Partner's pricing plan. If the API Keys page is unavailable, contact your Xyte account manager.

Using it

Pass the key in the Authorization header on every Partner Core API request:

Authorization: <your-partner-key>

The key resolves to your Partner server-side, so there is no tenant identifier or per-Cloud base URL to configure.

Treat the key as a secret. It carries your Partner's permissions across the entire Partner Cloud, so it belongs in a secrets manager or an environment variable rather than in source control. Revoke and reissue from the same page if a key is exposed.

📘

A Partner Key is not a Hardware Key

A Partner Key authenticates you as the Partner against the Partner Core API. A Hardware Key provisions and registers Devices of a single Device Model, and is found under Models → your Model → Hardware Keys. The two are separate credentials with separate scopes and are not interchangeable.

Related

  • Partner Core API — the endpoints this key authorizes.
  • Xyte MCP server — connects an AI assistant to the same API using this key.
  • Glossary — canonical names for the entities used across this documentation.