Основные принципы

С помощью этого интерфейса вы можете интегрировать сервис мониторинга Movizor в свою систему для любого варианта использования:

  • оперативно подключать и управлять своими объектами из своей CRM/ERP-системы;
  • предоставлять доступ к информации о местоположении своим клиентам на своём сайте (например, в Личном кабинете);
  • интегрировать гибкий мониторинг как услугу в своём приложении или в услуге для своих клиентов;
  • автоматизировать процесс подключения мониторинга в своих заказах; и многое другое!

Интерфейс доступен всем клиентам. Для подключения ознакомьтесь с документацией и оставьте заявку для активации в разделе Настройки API.

Протокол основан на простом вызове URL-адреса по протоколу HTTPS REST, ответ в формате JSON.

Формат запросов: GET или POST.
Кодировка запросов и ответов: UTF-8.
Адрес интерфейса: https://movizor.ru/api_2/
В каждом запросе должны быть обязательные параметры: project (название проекта) и key (ключ доступа, аналог токена). Значения этих параметров можно получить в разделе Настройки API.

Например, запрос на добавление абонента:

https://movizor.ru/api_2/mycompany/object_add/?key=123&phone=79991234567&title=Test&tariff=2

Варианты использования API-интерфейса

Процесс мониторинга (например, при грузоперевозках) выглядит следующим образом:

  1. При формировании заявки на перевозку в своей учетной системе (1С/ERP/CRM) отправляйте запрос на подключение абонента методом object_add. В случае ошибки показывайте логисту ее текст (например, указан несуществующий номер или неподдерживаемый оператор);
  2. В заявке отображайте статус подключения объекта (из методов object_get или object_list) для визуального контроля логисту;
  3. При необходимости узнать местоположение - добавьте кнопку "Определить местоположение" с вызовом метода pos_request. Либо используйте автоматические тарифы;
  4. В заявке отображайте карту с местоположением или данные из аналитики (из метода object_get: населенный пункт, оставшееся расстояние, прогноз успеваемости и тд);
  5. По окончании перевозки отключайте объект методом object_delete.

Из системы можно выгружать полученные данные периодически следующими методами:

  • object_list - список всех объектов и их статусы;
  • pos_objects - список всех объектов с последними координатами.
  • pos_last - последнее местоположение конкретного объекта
  • pos_list - список местоположений в указанный диапазон времени по конкретному объекту;
  • events - список событий по всему аккаунту.

При использовании тарифа "Вручную" делайте запросы на определение местоположения методом pos_request, в ответе будет request_id, по которому в методе pos_get можно получить информацию о запросе и координатах. Запрос на определение местоположения обрабатывается примерно 5-10 секунд.

При использовании автоматических тарифов (например, Онлайн или каждый час), достаточно выгружать периодически текущее местоположение и аналитику методом pos_last (например, каждые 10 минут).

Определения

Объект - это сотовый номер телефона в международном формате MSISDN, используемый для мониторинга. Например, 79991112233. Во всех методах можно передавать в человекочитаемом виде (например, +7 (999) 111-22-33) или в любом другом, система постарается привести его к международному формату.

Запрос - это запрос на определение местоположения абонента (методом pos_request). Является тарифицируемым, поэтому его стоит использовать осторожно. Например, не делать 50 запросов в течение дня, так как тариф "Автоматически онлайн" будет гораздо дешевле.