REST API: различия между версиями
Материал из Planfix
Artem (обсуждение | вклад) Нет описания правки |
Artem (обсуждение | вклад) |
||
| (не показано 16 промежуточных версий 2 участников) | |||
| Строка 23: | Строка 23: | ||
== | == Оглавление == | ||
*[[REST API Введение| Введение]] | *[[REST API Введение| Введение]] | ||
*[[Условия использования API]] | *[[Условия использования API]] | ||
| Строка 29: | Строка 29: | ||
*[[REST API Список уровней доступа – scope | Список уровней доступа – scope]] | *[[REST API Список уровней доступа – scope | Список уровней доступа – scope]] | ||
*[[REST API Коды ошибок |Коды ошибок]] | *[[REST API Коды ошибок |Коды ошибок]] | ||
*[[REST API Типы пользовательских полей |Типы пользовательских полей]] | |||
*[[REST API: Сложные фильтры задач |Сложные фильтры задач]] | *[[REST API: Сложные фильтры задач |Сложные фильтры задач]] | ||
*[[REST API: Сложные фильтры проектов |Сложные фильтры проектов]] | |||
*[[REST API: Сложные фильтры сотрудников |Сложные фильтры сотрудников]] | |||
*[[REST API: Сложные фильтры контактов |Сложные фильтры контактов]] | |||
*[[REST API: Сложные фильтры аналитик |Сложные фильтры аналитик]] | |||
*[[REST API: Сложные фильтры справочников |Сложные фильтры справочников]] | |||
*[[Отчеты по API]] | |||
*[[REST API: Работа с файлами |Работа с файлами]] | |||
*[[Тестирование запросов по REST API в Postman]] | *[[Тестирование запросов по REST API в Postman]] | ||
== Спецификация == | == Спецификация == | ||
| Строка 42: | Строка 48: | ||
== Режим без уведомлений == | == Режим без уведомлений == | ||
В | В любом запросе обновления данных возможно добавить параметр '''silent=true''' (query parameter). При этом изменение не будет отражено в логах и по нему не будут рассылаться уведомления. Это может быть необходимо при изначальном переносе данных в ПланФикс из другой системы посредством этого API или при периодической синхронизации данных другой системы с ПланФиксом. | ||
== Дополнительно == | |||
*Поступающие в ПланФикс данные перед дальнейшим использованием можно дополнительно [[Вычислить инфоблок |обработать]]. | |||
*При изменении задач через REST API методом POST /task/{id} действует следующая логика: если задача находится в процессе параллельного изменения (автоматическим сценарием или другим запросом) и не может быть сейчас изменена, ожидаемое изменение сохранится в очередь внутри ПланФикса и выполнится, когда задача освободится. При этом статус ответа будет 202, если ожидаемое изменение произведено сразу — ответ 200. | |||
== Перейти == | == Перейти == | ||
*[[Разработчикам: API]] | *[[Разработчикам: API]] | ||
Текущая версия от 09:19, 25 сентября 2024
Работа с API доступна только в платных или премиум-аккаунтах. Функционал REST API не полный. Мы постепенно его расширяем.
ПланФикс REST API — это набор интерфейсов, предназначенный для доступа к данным ПланФикс-аккаунта используя протокол HTTP и формат данных JSON.
API позволяет быстро и просто создавать веб- и настольные приложения, которые можно интегрировать с любым ПланФикс-аккаунтом.
Вот несколько вариантов, для чего можно использовать интерфейсы ПланФикс API:
- Создание собственных приложений или сервисов на базе ПланФикс;
- Разработка дополнений к основному функционалу ПланФикс, расширение возможностей использования сервиса;
- Импорт данных из других систем в ПланФикс;
- Экспорт данных из ПланФикса в другие системы;
- Организация уведомлений о задачах и действиях в ПланФиксе удобным для клиента способом;
- Портирование сервиса ПланФикс на другие платформы, в том числе и мобильные;
- Создание сервисов для получения и дальнейшего использования аналитической информации, находящейся в ПланФикс.
Оглавление
- Введение
- Условия использования API
- Авторизация
- Список уровней доступа – scope
- Коды ошибок
- Типы пользовательских полей
- Сложные фильтры задач
- Сложные фильтры проектов
- Сложные фильтры сотрудников
- Сложные фильтры контактов
- Сложные фильтры аналитик
- Сложные фильтры справочников
- Отчеты по API
- Работа с файлами
- Тестирование запросов по REST API в Postman
Спецификация
- Спецификация REST API доступна по ссылке: https://help.planfix.com/restapidocs/
- Если использовать ссылку на REST API из вашего аккаунта, тогда запросы будут выполняться непосредственно в вашем аккаунте, а не на тестовых данных:
Режим без уведомлений
В любом запросе обновления данных возможно добавить параметр silent=true (query parameter). При этом изменение не будет отражено в логах и по нему не будут рассылаться уведомления. Это может быть необходимо при изначальном переносе данных в ПланФикс из другой системы посредством этого API или при периодической синхронизации данных другой системы с ПланФиксом.
Дополнительно
- Поступающие в ПланФикс данные перед дальнейшим использованием можно дополнительно обработать.
- При изменении задач через REST API методом POST /task/{id} действует следующая логика: если задача находится в процессе параллельного изменения (автоматическим сценарием или другим запросом) и не может быть сейчас изменена, ожидаемое изменение сохранится в очередь внутри ПланФикса и выполнится, когда задача освободится. При этом статус ответа будет 202, если ожидаемое изменение произведено сразу — ответ 200.