API

Web API Fasttrack позволяет производить более сложную интеграцию и использовать все возможности платформы на полную мощность.

Быстрая навигация:

  • Авторизация

  • Общее описание

  • Пагинация

  • Методы

  • Лимиты

  • Ошибки

Авторизация

Каждый запрос к API должен сопровождаться заголовком bot-key. Ключ можно получить в разделе «Системные настройки»:

Здесь картинка: attachments/2685141001/2724233220.png

Общее описание

Web API выдержан в стиле REST. Описание всех доступных методов — доступно в Swagger.

Взаимодействовать с API возможно только по протоколу HTTPS.

Примечание: Базовый URL Web API Fasttrack: https://dashboard.fstrk.io/api/partners

Пагинация

В методах API, которые возвращают множество объектов, используется пагинация списка:

  • limit — кол-во возвращаемых объектов;

  • offset — сдвиг на количество объектов (то количество, которое следует пропустить учитывая все фильтры и сортировки).

Максимальное количество объектов на странице (limit) равняется 100.

Методы

Все доступные методы API описаны в Swagger.

Лимиты

Максимально допустимое количество запросов через API для одного бота — 5 в секунду.

Примечание: При превышении лимита: сервер будет отвечать статусом 429 (Too Many Requests).

Ошибки

Все возможные ошибки с кодами ответов описаны в Swagger.

Last updated