REST API: различия между версиями

Материал из Planfix
Перейти к: навигация, поиск
(Новая страница: «{{#seo: |title=REST API |titlemode=append |keywords=планфикс, апи, api, REST API |description=REST API }} '''ПланФикс REST API''' — это н…»)
 
 
(не показана 31 промежуточная версия 2 участников)
Строка 5: Строка 5:
|description=REST API
|description=REST API
}}
}}
<div style="background:#ffbaba;padding:10px;border:1px solid #ff9b9b;">Работа с API доступна только в платных или премиум-аккаунтах. Функционал REST API не полный. Мы постепенно его расширяем.</div>
'''ПланФикс REST API''' — это набор интерфейсов, предназначенный для доступа к данным ПланФикс-аккаунта используя протокол HTTP и формат данных JSON.
'''ПланФикс REST API''' — это набор интерфейсов, предназначенный для доступа к данным ПланФикс-аккаунта используя протокол HTTP и формат данных JSON.


API позволяет быстро и просто создавать веб- и настольные приложения, которые можно интегрировать с любым ПланФикс-аккаунтом.
API позволяет быстро и просто создавать веб- и настольные приложения, которые можно интегрировать с любым ПланФикс-аккаунтом.


Вот несколько вариантов, для чего можно использовать интерфейсы ПланФикс API:
Вот несколько вариантов, для чего можно использовать интерфейсы ПланФикс API:
Строка 19: Строка 23:




== Важно ==
== Оглавление ==
Работа с API доступна только в платных или премиум-аккаунтах.
*[[REST API Введение| Введение]]
*[[Условия использования API]]
*[[REST API Авторизация |Авторизация]]
*[[REST API Список уровней доступа – scope | Список уровней доступа – scope]]
*[[REST API Коды ошибок |Коды ошибок]]
*[[REST API Типы пользовательских полей |Типы пользовательских полей]]
*[[REST API: Сложные фильтры задач |Сложные фильтры задач]]
*[[REST API: Сложные фильтры проектов |Сложные фильтры проектов]]
*[[REST API: Сложные фильтры сотрудников |Сложные фильтры сотрудников]]
*[[REST API: Сложные фильтры контактов |Сложные фильтры контактов]]
*[[REST API: Сложные фильтры аналитик |Сложные фильтры аналитик]]
*[[REST API: Сложные фильтры справочников |Сложные фильтры справочников]]
*[[Отчеты по API]]
*[[REST API: Работа с файлами |Работа с файлами]]
*[[Тестирование запросов по REST API в Postman]]


== Спецификация ==
*Спецификация REST API доступна по ссылке: https://help.planfix.com/restapidocs/
*Если использовать ссылку на REST API из вашего аккаунта, тогда запросы будут выполняться непосредственно в вашем аккаунте, а не на тестовых данных:


== Перейти ==
https://p.pfx.so/pf/SN/ZJbAzh.png
*[[Введение]]
*[[Условия использования API]]
*[[REST API: Авторизация |Авторизация]]
*[[Коды ошибок]]




== Режим без уведомлений ==
== Режим без уведомлений ==
В параметре любого запроса возможно добавить параметр '''silent=1''' или '''silent=true'''. При этом изменение не будет отражено в логах и по нему не будут рассылаться уведомления. Это может быть необходимо при изначальном переносе данных в ПланФикс из другой системы посредством этого API или при периодической синхронизации данных другой системы с ПланФиксом.
В любом запросе обновления данных возможно добавить параметр '''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:

  • Создание собственных приложений или сервисов на базе ПланФикс;
  • Разработка дополнений к основному функционалу ПланФикс, расширение возможностей использования сервиса;
  • Импорт данных из других систем в ПланФикс;
  • Экспорт данных из ПланФикса в другие системы;
  • Организация уведомлений о задачах и действиях в ПланФиксе удобным для клиента способом;
  • Портирование сервиса ПланФикс на другие платформы, в том числе и мобильные;
  • Создание сервисов для получения и дальнейшего использования аналитической информации, находящейся в ПланФикс.


Оглавление

Спецификация

  • Спецификация REST API доступна по ссылке: https://help.planfix.com/restapidocs/
  • Если использовать ссылку на REST API из вашего аккаунта, тогда запросы будут выполняться непосредственно в вашем аккаунте, а не на тестовых данных:

ZJbAzh.png


Режим без уведомлений

В любом запросе обновления данных возможно добавить параметр silent=true (query parameter). При этом изменение не будет отражено в логах и по нему не будут рассылаться уведомления. Это может быть необходимо при изначальном переносе данных в ПланФикс из другой системы посредством этого API или при периодической синхронизации данных другой системы с ПланФиксом.


Дополнительно

  • Поступающие в ПланФикс данные перед дальнейшим использованием можно дополнительно обработать.
  • При изменении задач через REST API методом POST /task/{id} действует следующая логика: если задача находится в процессе параллельного изменения (автоматическим сценарием или другим запросом) и не может быть сейчас изменена, ожидаемое изменение сохранится в очередь внутри ПланФикса и выполнится, когда задача освободится. При этом статус ответа будет 202, если ожидаемое изменение произведено сразу — ответ 200.

Перейти

Источник — http://planfix.com/ru/help/index.php?title=REST_API&oldid=46818