REST API: Введение

Для начала работы приложения сгенерируйте токен авторизации. Сделать это может владелец аккаунта в разделе: Управление аккаунтом — Доступ к API — REST API.

Обратите внимание, работа с API доступна только в платных или премиум-аккаунтах.

Доступ к интерфейсу

• Доступ к интерфейсу осуществляется через точку входа, адрес которой доступен в разделе REST API:
  • https://имя_вашего_аккаунта.planfix.ru/rest/
• Там же доступна ссылка на спецификацию по REST и полигон для отладки запросов в ваш аккаунт.
• Запросы, отправленные со страницы спецификации API, выполняются непосредственно в вашем аккаунте, не на тестовых данных.

Обратите внимание

Доступ к интерфейсу осуществляется по протоколу HTTPS. Все запросы, использующие незащищенное соединение, будут автоматически игнорироваться. Мы рекомендуем устанавливать тестовое безопасное соединение с точкой доступа к интерфейсам ПланФикс перед отправкой данных.

Ограничения по запросам от приложения

• У всех аккаунтов есть ограничение в зависимости от оплаченного пакета:
  • 20 / 50 / 100 000 запросов в сутки
  • 1 запрос в секунду
• Для методов, которые возвращают списки значений, установлено ограничение в размере 100 результатов за один запрос.
• Примерное количество оставшихся запросов в сутки возвращается в заголовке X-RateLimit-Remaining — значение обновляется примерно раз в 10 минут.

Перейти

• REST API