REST API Введение: различия между версиями
Материал из Planfix
Artem (обсуждение | вклад) Нет описания правки |
Artem (обсуждение | вклад) Нет описания правки |
||
| (не показаны 3 промежуточные версии этого же участника) | |||
| Строка 6: | Строка 6: | ||
|description=REST API Введение | |description=REST API Введение | ||
}} | }} | ||
<div style="background:#ffbaba;padding:10px;border:1px solid #ff9b9b;">Работа с API доступна только в платных или премиум-аккаунтах.</div> | |||
Для начала работы приложения сгенерируйте токен авторизации. Сделать это может владелец аккаунта в разделе: '''Управление аккаунтом''' — '''Доступ к API''' — '''REST API'''. | Для начала работы приложения сгенерируйте токен авторизации. Сделать это может владелец аккаунта в разделе: '''Управление аккаунтом''' — '''Доступ к API''' — '''REST API'''. | ||
== Доступ к интерфейсу == | == Доступ к интерфейсу == | ||
*Доступ к интерфейсу осуществляется через точку входа, адрес которой доступен в разделе REST API: | *Доступ к интерфейсу осуществляется через точку входа, адрес которой доступен в разделе REST API: | ||
**<nowiki>https://имя_вашего_аккаунта.planfix.ru/rest/</nowiki> | **'''<nowiki>https://имя_вашего_аккаунта.planfix.ru/rest/</nowiki>''' | ||
*Там же доступна ссылка на спецификацию по REST и полигон для отладки запросов в ваш аккаунт. | *Там же доступна ссылка на спецификацию по REST и полигон для отладки запросов в ваш аккаунт. | ||
*Запросы, отправленные со страницы спецификации API, выполняются непосредственно в вашем аккаунте, не на тестовых данных. | *Запросы, отправленные со страницы спецификации API, выполняются непосредственно в вашем аккаунте, не на тестовых данных. | ||
| Строка 23: | Строка 24: | ||
== Ограничения по запросам от приложения == | == Ограничения по запросам от приложения == | ||
* | *У всех аккаунтов есть ограничение в зависимости от оплаченного пакета: | ||
**20 / 50 / 100 000 запросов в сутки | |||
**1 запрос в секунду | |||
*Для методов, которые возвращают списки значений, установлено ограничение в размере 100 результатов за один запрос. | *Для методов, которые возвращают списки значений, установлено ограничение в размере 100 результатов за один запрос. | ||
*Примерное количество оставшихся запросов в сутки возвращается в заголовке '''X-RateLimit-Remaining''' — значение обновляется примерно раз в 10 минут. | *Примерное количество оставшихся запросов в сутки возвращается в заголовке '''X-RateLimit-Remaining''' — значение обновляется примерно раз в 10 минут. | ||
Текущая версия от 06:25, 4 июля 2022
Работа с API доступна только в платных или премиум-аккаунтах.
Для начала работы приложения сгенерируйте токен авторизации. Сделать это может владелец аккаунта в разделе: Управление аккаунтом — Доступ к API — REST API.
Доступ к интерфейсу
- Доступ к интерфейсу осуществляется через точку входа, адрес которой доступен в разделе REST API:
- https://имя_вашего_аккаунта.planfix.ru/rest/
- Там же доступна ссылка на спецификацию по REST и полигон для отладки запросов в ваш аккаунт.
- Запросы, отправленные со страницы спецификации API, выполняются непосредственно в вашем аккаунте, не на тестовых данных.
Обратите внимание
Доступ к интерфейсу осуществляется по протоколу HTTPS. Все запросы, использующие незащищенное соединение, будут автоматически игнорироваться. Мы рекомендуем устанавливать тестовое безопасное соединение с точкой доступа к интерфейсам ПланФикс перед отправкой данных.
Ограничения по запросам от приложения
- У всех аккаунтов есть ограничение в зависимости от оплаченного пакета:
- 20 / 50 / 100 000 запросов в сутки
- 1 запрос в секунду
- Для методов, которые возвращают списки значений, установлено ограничение в размере 100 результатов за один запрос.
- Примерное количество оставшихся запросов в сутки возвращается в заголовке X-RateLimit-Remaining — значение обновляется примерно раз в 10 минут.