Quick Start

Authentication

Create an API Access Token from the "API Access" MDM page (see detailed documentation).

Once your token is created, you will have to set it in the header of each request to the API:

Authorization: Bearer abcdefghijk

Definitions

You can find here the API documentation where you can also download the OpenAPI schema and open it with an API testing tool.

If using Postman, import the file as a Collection with the following advanced options:

• Naming requests: URL
• Request parameter generation: Schema
• Response parameter generation: Schema
• Folder organization: Tags

Then edit the collection:

• Add your access token in Authorization → Bearer Token : my_token
• Set Variables → baseUrl : https://my.famoco.com

Throttling

API calls are rate-limited to prevent abusive usage which could degrade the performance of the service.

The mechanism limits the number of requests per client for a given time window. Beyond that limit, the API returns an HTTP error (429 Too Many Requests) until the counter is reset, at the end of the time window.

All API requests are limited to a maximum of 100 requests/minute and 1000 requests/hour per client, except for exports (/api/organizations/<id>/exports/) which are limited to 6 requests/minute per client.

Note

A client is identified as a user (if authenticated), through an API Access Token, or with their IP address (if it is not authenticated).

Here is a sample response from a request that was rate-limited. The number of seconds to wait before new requests can be sent is given in the Retry-After header.

HTTP 429 Too Many Requests
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json
Retry-After: 3254
Vary: Accept

{
    "errors": {
        "detail": "Request was throttled. Expected available in 3254 seconds."
    }
}