Плагин представляет собой архив в формате .zip. В состав архива входят:
- папка licenses, содержащая файлы лицензий;
- папка icon, содержащая файлы с используемыми пиктограммами для регистрируемых событий;
- файл manifest.json, содержащий информацию о плагине.
Примечание:
Папки licenses и icon не являются обязательными. Файлы лицензий и файлы с используемыми пиктограммами могут находиться в корне.
Для внешних систем-источников событий файл manifest.json должен содержать следующую информацию:
| Содержимое | Тип данных | Является обязательным | Описание |
|---|---|---|---|
{ | |||
| Строка | Да | Уникальный идентификатор (UUID) плагина. До 40 символов. |
"DISPLAY_NAME": "", | Строка | Да | Отображаемое имя плагина. Пример: "DISPLAY_NAME": "Имя плагина", |
"DESCRIPTION": "", | Строка | Нет | Отображаемое описание плагина. Пример: "DESCRIPTION": "Тестовый плагин для демонстрации", |
"VERSION": "", | Строка | Да | Версия плагина. Пример: "VERSION": "1.0.0", |
"VENDOR": "", | Строка | Да | Идентификатор компании-разработчика, соответствующий названию компании в лицензии. Пример: "VENDOR": "infowatch", |
| Массив Строка | Да | Файлы лицензии. Должны быть указаны пути к файлам лицензий относительно корня архива. Пример: "LICENSE": [ { "PATH":"licenses/файл лицензии 1.license" }, ], |
"PATTERN_SEARCH_LICENSE": "", | Строка | Нет | Шаблон для поиска загруженных ранее лицензий для привязки их к плагину. Имеет формат: {operator:or|and,child[{name:value}]}".Пример: "PATTERN_SEARCH_LICENSE": "{\"operator\":\"or\",\"conditions\":[{\"origin\":\"dm\"},{\"origin\":\"dmmobile\"}]}", |
| Массив | Да | Список типов данных с указанием систем-источников. Пример:
|
} |
Важно!
В состав файла входит просроченная лицензия. Для регистрации плагина на основании файла примера нужно будет получать новую лицензию.
Полная JSON-схема входит в состав примеров SDK (см. раздел "Описание примеров PushAPI SDK"). Пример файла регистрации модуля входит в состав SDK.