Introduction

Fitmate Partners API is used to interact between Information systems of US doctors and our coaching system.

Authentication

The Fitmate Partners API uses API keys to authenticate requests.

You can view and manage your API keys in the Partners Dashboard.

Example

const axios = require('axios');

const res = axios({
  url: 'https://partners.ftmtapi.com/foo',
  method: 'post',
  data: {
    email: 'string',
  },
  headers: {
    Authorization: 'Bearer <YOUR_API_KEY>',
    'Fitmate-Version': '2023-08-01',
  },
});

Errors

Fitmate uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided. Codes in the 5xx range indicate an error with Fitmate's servers (these are rare).

Here is the list of HTTP codes that can be returned by the API:

Code	Description
200	Everything is working as expected
400	Bad request
403	Forbidden
404	Not found
500	Server error

Endpoint Url

Here is the list of the main urls for our APIs:

Environment	Url
Sandbox	https://partners-sandbox.ftmtapi.com/
Production	https://partners.ftmtapi.com/

Versionning

When backwards-incompatible changes are made to the API, a new, dated version is released. The current version is 2023-08-22.

Read our API upgrades guide to learn more about backwards compatibility. For all API updates, view our API changelog.

All requests use your account API settings, unless you override the API version.

To set the API version on a specific request, send a Fitmate-Version header.

You can visit your Dashboard to upgrade your API version. As a precaution, use API versioning to test a new API version before committing to an upgrade.