Плагины¶
Получить список всех зарегистрированных плагинов для аккаунта¶
GET /v1.3/plugins
После успешного выполнения возвращается массив объектов, описывающих плагины.
id | integer | Идентификатор плагина |
type | string | Тип плагина |
name | string | Имя плагина |
status | integer | Статус плагина |
Пример:
GET https://api.umnico.com/v1.3/plugins
Response:
[
{
"id": 1001,
"type": "vtiger",
"name": "Plugin #1",
"status": 1,
},
{
"id": 1002,
"type": "bitrix",
"name": null,
"status": 1,
}
]
Зарегистрировать плагин для аккаунта¶
POST /v1.3/plugins
Тело запроса:
- type - один из поддерживаемых типов плагина (идентификатор подключаемой системы): bitrix, vtiger
- name - (необязательный параметр) - имя плагина
- metadata - (необязательный параметр) - объект метаданных произвольной структуры, сохраняется и возвращается в дальнейшем в неизменном виде
После успешного выполнения возвращается следующий объект.
id | integer | Идентификатор зарегистрированного плагина |
type | string | Тип зарегистрированного плагина, повторяет строку, переданную в теле запроса |
name | string | Имя плагина |
metadata | объект или null | Метаданные плагина, повторяет объект, переданный в теле запроса |
status | integer | Статус зарегистрированного плагина |
pluginToken | string | Токен доступа пользователя плагина для дальнейшей аутентификациии как пользователя API |
Пример:
POST https://api.umnico.com/v1.3/plugins
Body:
{
"type": "vtiger",
"name": "Plugin #2",
"metadata": {
"foo": 123,
"bar": []
}
}
Response:
{
"id": 1000,
"type": "vtiger",
"name": "Plugin #2",
"metadata": {
"foo": 123,
"bar": []
},
"status": 1,
"pluginToken": "e3527e91-495c-4b30-8f42-fc5adc7493be"
}
Удалить зарегистрированный плагин¶
DELETE /v1.3/plugins/<pluginId>
- pluginId - идентификатор плагина в Umnico
Тело запроса отсуствует
После успешного выполнения возвращается ответ со статусом 204, тело ответа отсутствует.
Пример:
DELETE https://api.umnico.com/v1.3/plugins/1000