REST API: Вступ

Матеріал з Planfix

Робота з API доступна лише у платних або преміум-акаунтах.

Щоб розпочати роботу застосунку, згенеруйте токен авторизації. Це може зробити керуючий акаунтом у розділі: Управління акаунтом — Доступ до API — REST API.

Доступ до інтерфейсу

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

Зверніть увагу

Доступ до інтерфейсу здійснюється за протоколом HTTPS. Усі запити, що використовують незахищене з'єднання, автоматично ігноруються. Рекомендуємо встановлювати тестове безпечне з'єднання з точкою доступу до інтерфейсів Planfix перед надсиланням даних.

Обмеження за запитами від застосунку

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

Перейти