Overview of Public API

The TeamTracks API allows for basic CRUD (Create/Read/Update/Delete) operations to be performed on objects in the system. These are REST APIs and authenticated using OAuth 2.0 specifications.

API Authentication

Generating an OAuth Client ID

All endpoints require the user calling them to be authenticated. Before you can start using the APIs, an OAuth client should be created in your TeamTracks instance. This is done using the OAuth Client registration page in the Admin Interface.

This will generate an OAuth client ID that is required for authenticating the API call.

Generating an Access Token

To generate an access token, you must make a POST request to the following URL:

https://api.team-tracks.com/auth/token

with the following two request headers,

tenant: <your_tenent_ID>
Ocp-Apim-Subscription-Key: <your_subscription_key>

and the following body,

{
    "clientId": "<OAuth_client_ID>",
    "email": "<api_username>",
    "password": "<api_user_password>"
}

The response will look like the following:

{
    "token": "Bearer <token>"
}

The token has a validity of 1 year from the date of issue.