API Key

An application that holds the API key is assumed to be authorized and trusted. More importantly, the application will also have full access to the instance's resources in HeyTeam.

This guide provides information on the steps required to make an API requests using API Key.

1. Obtaining an API Key

To obtain a new API key for HeyTeam, you can simply reach out to us and request one. HeyTeam should be able to provide you with a new key relatively quickly, and once you have it, you can use it to access our API services.

🚧

Keeping your API key safe and secure

Because an API key provide full access to the instance's resource in HeyTeam, we strongly recommend you to keep these Client Credentials safe and secure to prevent the API key from falling into the wrong hands.

2. Making an API request

To make an API request to our API, include the API key in the header of the request as a Authorization: Bearer 'your-api-key' Bearer like the following example request:

curl --request GET \
     --url https://[your-domain].heyteam.com/eapi/configuration/languages \
     --header 'accept: application/json' \
     --header 'Authorization: Bearer <token>'

If the call is successful, you should receive 200 code and a JSON response like the following :

{
    "data": [
        {
            "id": 1,
            "code": "fr-FR",
            "is_enabled": true,
            "is_default": true
        },
        {
            "id": 2,
            "code": "en-US",
            "is_enabled": false,
            "is_default": false
        }
    ]
}

3. Revoking access

The API Key does not have an expiration date. And in scenario where an API key is not used, lost or suspected to be used maliciously by a third party, admins can revoke the key simply by reaching out out to us.