Authentication

​

API Keys

Every account can create a maximum of 3 API keys from the Integration Page. If you’ve already signed up, you’ll have created one during onboarding.

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

​

Anatomy of an API key

Each API key is made up of 2 parts seperated 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.

​

Authenticating Requests

When making requests to the API, make sure to include both parts of your API key in the X-API-KEY header as in this example:

curl https://app.trophy.so/api/users/<userId>/metrics/<key> \
     -H "X-API-KEY: ********.***********************"

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

​

Managing API keys

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

​

Rotating keys

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.

​

Revoking keys

API keys can also be revoked entirely at which point they become Inactive. At the point of revokation, 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.

​

Deleting API keys

If you’re 100% sure you no longer need an 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!