Блог

API Планадо – это механизм управления нарядами, объектами, клиентами и сотрудниками в автоматическом режиме из других программ. Обычно IT-отдел компании-клиента реализует через API один из сценариев автоматического обмена данными между ПО клиента (CRM, конфигурацией 1С или Helpdesk или самописной программой) и Планадо.

Если выездов много или есть задача минимизировать ошибки ручного ввода, то обязательно нужно делать интеграцию, она часто окупается.

Основные возможности API Планадо:

• Добавить наряд, обычно на основании готового шаблона нарядов.
• Частично изменить данные в наряде.
• Изменить состояние наряда.
• Получить данные из отчета по наряду. Можно получить данные, когда и где нажимались кнопки в наряде. И, конечно, заполненные удаленным сотрудником данные, включая фотографии.
• Получить историю перемещений удаленным сотрудником по наряду.

Обычно API программных продуктов в лучшем случае предоставляет только этот базовый набор возможностей API, но с ним есть проблемы. ПО клиента желательно как-то знать момент, что удаленный сотрудник выполнил какие-то действия в Планадо. Для этого в Планадо есть вебхуки – это события, которые отправляют запросы в вашу систему. Например, если выездной сотрудник выехал на наряд, закончил работу или даже нажал на кнопку в наряде. Вебхуки это механизм отправки запроса в ПО клиента по инициативе Планадо.

Кейс использования вебхуков 1: синхронизация данных

Устанавливается вебхук на изменение данные. В таком случае после внесения изменений будет выполнен внешний запрос и будут переданы данные до и после изменений. Таким образом в принимающей вебхук системе можно узнать какие были изменения и выполнить обновление только тех данных, которые были изменены. 

Кейс использования вебхуков 2: уведомления

Устанавливается вебхук на изменение состояния наряда. Например, таким образом можно реализовать отправку своих уведомлений через свой SMS-шлюз (и со своим альфа-именем отправителя) или через EMAIL клиенту при выезде к клиенту сотрудника. Прислать опросник о выполненной работе после завершения наряда.

Механизм вебхуков позволяет уйти от технически трудоемкой и плохо работающей схемы интеграции, когда вы постоянно из двух систем получаете большой объем данных и анализируете их на наличие изменений. 

Но если для интеграции нет возможности использовать вебхуки, то в Планадо есть возможность выполнить запрос и получить изменения за определенный период времени.

Но разработчики Планадо пошли дальше и реализовали механизм гарантированной доставки вебхуков. Часто бывает, что при попытке отправить в ПО клиента данные из Планадо нет связи или по какой-то причине данные не были приняты, например, проводились работы на сервере. В этом случае Планадо будет повторно отправлять данные на протяжении довольно долгого времени (больше недели) пока не добьется того, чтобы данные из Планадо не потерялись и были загружены в ПО клиента, с которым реализована интеграция.

Основные сценарии интеграции Планадо и ПО клиента: 

1.  Добавление нарядов из CRM (CRM – ПО клиента). Клиент оставляет заявку в CRM, менеджер подтверждает ее и создает сделку, потом переводит ее в другое состояние (стадию). Например, это может быть состояние “К замеру” (создается наряд в Планадо по шаблону выезда замерщика), “К монтажу” (создается наряд по шаблону монтажных работ), “К доставке” (шаблон на доставку) и т.д. После выполнения работ данные из отчета Планадо загружаются в CRM и сделка переходит в следующее состояние автоматически (“На контроле” или “К расчету”).
2. Клиент обращается в техподдержку, регистрируется заявка в Helpdesk (Helpdesk – ПО клиента). После обработки заявки сотрудник техподдержки понимает, что для решения проблемы нужен выезд к клиенту. Он переводит состояние заявки, например, “К выезду” и автоматически создается наряд на выезд в Планадо. После выполнения наряда данные с отчетом выполнения работы выездным сотрудником загружаются обратно в Планадо и меняется состояние заявки (например, “Проверка работы” или “Обратная связь”).

Более сложные схемы интеграции:

3. Сделать проверки правильности заполнения данных в отчете по наряду выездным сотрудником. Например, если выбрана опция “наличие брака”, то обязательно нужно сделать “фотографию брака” и заполнить “описание брака”. Такую проверку можно сделать через поле-кнопку, при нажатии на которую будет отправляться запрос на ваш сервер. Принимающий запрос скрипт выполнит проверку и вернет обратно результат. Результатом может быть сообщение, которое отобразится в мобильном приложении выездному сотруднику, например: “Данные заполнены с ошибкой, сделайте фотографию брака”.
4. После обработки вебхука по наряду в ответ через API можно отобразить или скрыть поля, сделать поля редактируемыми и нередактируемыми. Или добавить новые поля в наряд через API, даже если этих полей не было в шаблоне наряда. Например, по нажатию на поле-кнопку в наряде проверяются, что выбрана опция “кухонный телевизор”, после чего в заказ добавляются поля для выбора тв-приставки на кухню.

Обо всех нововведениях читайте в документации по API.