Формулировка проблемы: для реализации партнерами внешнего модуля интеграции требуется API генерирования событий.
Решение: необходимо реализовать новый метод
API
, позволяющий генерировать
произвольные
события.
URL
метода:
rest/api/events/create
. Типа запроса:
POST
.
Метод принимает следующие обязательные параметры:
eventName
- название события (строка);
eventMsg
- произвольный
json
(строка).
В случае успешного выполнения метода сервер вернет сообщение «Событие успешно сгенерировано».
Альтернативные потоки событий:
если параметр eventName
не передан, либо он
пустой, сервер вернет сообщение «Не передан параметр
eventName
», событие не генерируется;
если передан некорректный параметр eventName
,
сервер вернет сообщение «Некорректный параметр
eventName
», событие не генерируется;
если параметр eventMsg
не передан, либо он
пустой, сервер вернет сообщение «Не передан параметр
eventMsg
», событие не генерируется.
Пример принимаемых параметров:
Событие, генерируемое мобильным клиентом по координатам
GPS
:
eventName=event.ext.gps&eventMsg={\"lat\":333.333,\"lon\":222.222}