Authentication

Integrate securely with the Admin API using account-level admin API keys transmitted in the X-API-KEY header.

For client-side or end-user access to the Application API, create application API keys scoped to a single user instead.

Admin API keys

Admin API keys are account-level credentials with broad permissions. Use them to authenticate requests to the Admin API, and optionally to the Application API from trusted server-side environments.

Every account can create a maximum of 3 admin API keys from the integration page of the Trophy dashboard.

Trophy keeps track of and displays when each admin API key in your account was created and when it was last used so you can easily keep track of usage.

Admin API keys can access any user and any admin operation in your account. Never expose them in client-side code, mobile apps, or public repositories.

Anatomy of an admin API key

Each admin API key is made up of 2 parts separated by a period:

{prefix}.{body}

• The prefix is the first 8 characters. It’s readable and will always stay the same so it’s easily recognisable.
• The body is the secret part, and is only shown to you once when you create the key.

When using the API, both parts of your admin API key must be sent in the X-API-KEY header.

Authenticating requests

When making requests to the Admin API, include both parts of your admin API key in the X-API-KEY header, or pass it when initializing an SDK client:

cURL

curl https://admin.trophy.so/v1/metrics \
     -H "X-API-KEY: YOUR_API_KEY"

import { TrophyApiClient } from "@trophyso/node";

const trophy = new TrophyApiClient({
  apiKey: "YOUR_API_KEY",
});

from trophy import TrophyApi

client = TrophyApi(
    api_key="YOUR_API_KEY",
)

use Trophy\TrophyClient;

$trophy = new TrophyClient("YOUR_API_KEY");

TrophyApiClient client = TrophyApiClient.builder()
    .apiKey("YOUR_API_KEY")
    .build();

import (
  trophyclient "github.com/trophyso/trophy-go/client"
  "github.com/trophyso/trophy-go/option"
)

client := trophyclient.NewClient(
  option.WithApiKey("YOUR_API_KEY"),
)

var trophy = new TrophyApiClient(
    apiKey: "YOUR_API_KEY"
);

client = Trophy::Client.new(
  api_key: "YOUR_API_KEY"
)

The same key authenticates Application API requests when you use an admin API key from a server-side environment:

cURL

curl https://api.trophy.so/v1/users/user_123/metrics/<key> \
     -H "X-API-KEY: YOUR_API_KEY"

import { TrophyApiClient } from "@trophyso/node";

const trophy = new TrophyApiClient({
  apiKey: "YOUR_API_KEY",
});

from trophy import TrophyApi

client = TrophyApi(
    api_key="YOUR_API_KEY",
)

use Trophy\TrophyClient;

$trophy = new TrophyClient("YOUR_API_KEY");

TrophyApiClient client = TrophyApiClient.builder()
    .apiKey("YOUR_API_KEY")
    .build();

import (
  trophyclient "github.com/trophyso/trophy-go/client"
  "github.com/trophyso/trophy-go/option"
)

client := trophyclient.NewClient(
  option.WithApiKey("YOUR_API_KEY"),
)

var trophy = new TrophyApiClient(
    apiKey: "YOUR_API_KEY"
);

client = Trophy::Client.new(
  api_key: "YOUR_API_KEY"
)

If you do not pass an API key, or your API key is invalid, you’ll receive a 401 response code.

Managing admin API keys

There are a few different operations you can perform on admin API keys from within your Trophy dashboard to manage your integration.

Rotating keys

Admin API keys can be rotated if you want to change them for any reason. At the point of rotation, the original API key will no longer function and any requests still using it will begin receiving 401 responses immediately.

Note that when rotating keys, both the prefix and the body will change.

Revoking keys

Admin API keys can also be revoked entirely at which point they become Inactive. At the point of revocation, the API key will no longer function and any requests still using it will begin receiving 401 responses immediately.

Once revoked you can re-activate the API key at any time.

Neither the prefix or the body of the key change when revoked or re-activated.

Deleting API keys

If you’re 100% sure you no longer need an admin API key, they can be deleted.

Get Support

Want to get in touch with the Trophy team? Reach out to us via email. We’re here to help!