REST API
Материал из Planfix
Работа с 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 или при периодической синхронизации данных другой системы с ПланФиксом.
Дополнительно
- Поступающие в ПланФикс данные перед дальнейшим использованием можно дополнительно обработать.