Skip to main content

Clients and keys

API Studio

A client is a caller of your APIs. It belongs to one environment and holds one or more API keys. Managing clients and keys needs the API client permission.

Operate > Access​

API Studio > Operate > Access on an API lists its clients, grouped by environment. Each client shows its status, its policy and its keys. Each key shows its prefix, status and when it was last used.

Creating a client​

  1. Open the API and open API Studio > Operate > Access.
  2. Enter a Client name and choose the Environment.
  3. Press Create client.

Creating a key​

  1. Press New key on the client.
  2. Press Copy and store the key.
  3. Press Done.

The key is shown once. After Done, only its prefix is shown.

Send the key as Authorization: Bearer <key> or X-API-Key: <key>. See Calling a deployed API.

Attaching a policy​

Choose a Policy on the client, or None. Policies are managed on the Policies page. See Policies and limits.

Revoking​

  • Revoke beside a key stops that key.
  • Revoke client stops the client and all its keys.

A revoked key stops working within 30 seconds. Revoking cannot be undone.

Every client in the account​

The Clients page, opened from the API Studio overview, lists every client across all APIs: its name, the API it belongs to or Any API, its environment, policy and status. A client can be revoked there too.