API and API keys

Trail provides an open API that allows other systems to read and write data in Trail.

API documentation can be found here: api-doc.trail.fi.

To use the API, API keys must first be enabled for your Trail environment. Contact Trail at support@trail.fi

You need access to the Admin module to manage API keys. If needed, Trail support can add on a setting that: Admins Can See All Api Keys

Topics:

  1. Creating an API key
  2. Download and active the API key
  3. Use the API key

Create a new API key

  1. Open Admin → API Keys

  1. Click Create

  1. Enter details for the API key
    1. Enter name
    2. Add a description (optional)
    3. Select the validity period
      1. This determines how long the API key can be used
    4. Add departments that API key can access
      1. The API key can only access the selected departments
    5. Set the required rights for the API key
      1. These rights apply specifically to this API key
      2. Only grant the rights that the integration needs

  1. Click Create
  2. For more information about different access rights, see User rights explained.

Download and activate the API key

After creating the API key, it appears in the API Keys list with the status Inactive.

  1. Find the API key in the list
  2. Download the key

  1. After the key has been downloaded, its status changes to Active

  1. The API key is now ready to use.
  2. Keep the downloaded API key secure and only share it with people or systems that need access to the Trail API.

Use the API key

API documentation can be found here: api-doc.trail.fi