Каналы интеграции (integration_points)

Запросы

HTTP verb Endpoint Описание

POST

/rest/v1/service/integration_points

Создание нового канала интеграции

GET

/rest/v1/service/integration_points

Получение списка каналов интеграции

GET

/rest/v1/service/integration_points/<id>

Получение данных канала интеграции

PATCH

/rest/v1/service/integration_points/<id>

Изменение данных канала интеграции

DELETE

/rest/v1/service/integration_points/<id>

Удаление канала интеграции

LOOKUP

/rest/v1/service/integration_points

Поиск идентификатора канала интеграции

Создание нового канала интеграции

Запрос

Описание полей: integration_point entity

Пример запроса
POST /rest/v1/service/integration_points HTTP/1.1
Content-Type: application/json; charset=utf-8

integration_point entity

Ответ

Описание полей: integration_point entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "b4680fbe-016c-d86f-1d6b-50e54938780c",
  "code": "ABCDE",
  "type": "public",
  "token_local": "82ddc7c68623726346a78371173e2f8d",
  "token_remote": "",
  "token_remote2": "",
  "url": "http://trapper.com",
  "recv_svcscriptcode": "ws_hook",
  "recv_svcscriptcode_ws": "",
  "send_svcscriptcode": "send_to_web",
  "send_svcscriptcode_ws": "",
  "opts": {
    "title": "",
    "comment": "",
    "allow_files_api": false,
    "issync": false
  },
  "ext": {
    "ct": "2019-08-28T13:34:16.42Z",
    "lwt": "2019-08-28T13:34:16.42Z"
  }
}

Получение списка каналов интеграции

Запрос

Table 1. Параметры запроса
Имя Тип Описание

filter

object

Фильтр по значениям полей.

mask

str

Список полей для вывода. Доступные поля для выдачи: id, code, type, tokenlocal, tokenremote, tokenremote2, recv_svcscriptcode, recv_svcscriptcode_ws, send_svcscriptcode, send_svcscriptcode_ws, opts.title, opts.allow_files_api, opts.issync, ext.lwt, ext.ct.

offset

int

Смещение в списке ресурсов, подлежащих выдаче.

limit

int

Максимальное количество ресурсов в списке.

order

array<object|str>

Порядок сортировки ресурсов в списке.

flat

bool

Преобразование в плоский вид составных полей.

Подробно про формат параметров GET-запроса

Пример запроса
GET /rest/v1/service/integration_points?offset=0&limit=2 HTTP/1.1

Ответ

Описание полей: integration_point entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "id": "b4680fbe-016c-d86f-1d6b-50e54938780c",
    "code": "ABCDE",
    "type": "public",
    "token_local": "82ddc7c68623726346a78371173e2f8d",
    "token_remote": "",
    "token_remote2": "",
    "url": "http://trapper.com",
    "recv_svcscriptcode": "ws_hook",
    "recv_svcscriptcode_ws": "",
    "send_svcscriptcode": "send_to_web",
    "send_svcscriptcode_ws": "",
    "opts": {
      "title": "",
      "allow_files_api": false,
      "issync": false
    },
    "ext": {
      "ct": "2019-08-28T13:34:16.42Z",
      "lwt": "2019-08-28T13:34:16.42Z"
    }
  },
  {
    "id": "a188288e-016c-d86f-cd99-50e54938780c",
    "code": "902",
    "type": "telegram",
    "token_local": "82ddc7c68623726346a78371173e2f8d",
    "token_remote": "",
    "token_remote2": "",
    "url": "http://trapper.com",
    "recv_svcscriptcode": "ws_hook",
    "recv_svcscriptcode_ws": "",
    "send_svcscriptcode": "send_to_web",
    "send_svcscriptcode_ws": "",
    "opts": {
      "title": "",
      "allow_files_api": false,
      "issync": false
    },
    "ext": {
      "ct": "2019-08-28T13:34:16.42Z",
      "lwt": "2019-08-28T13:34:16.42Z"
    },
    "ext": {
      "ct": "2019-08-28T13:35:01.52Z",
      "lwt": "2019-08-28T13:35:01.52Z"
    }
  }
]

Получение данных канала интеграции

Запрос

Table 2. Параметры запроса
Имя Тип Описание

mask

str

Список полей для вывода.

flat

bool

Преобразование в плоский вид составных полей.
Пример запроса
GET /rest/v1/service/integration_points/a188288e-016c-d86f-cd99-50e54938780c HTTP/1.1

Ответ

Описание полей: integration_point entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "b4680fbe-016c-d86f-1d6b-50e54938780c",
  "code": "ABCDE",
  "type": "public",
  "token_local": "82ddc7c68623726346a78371173e2f8d",
  "token_remote": "",
  "token_remote2": "",
  "url": "http://trapper.com",
  "recv_svcscriptcode": "ws_hook",
  "recv_svcscriptcode_ws": "",
  "send_svcscriptcode": "send_to_web",
  "send_svcscriptcode_ws": "",
  "opts": {
    "title": "",
    "comment": "",
    "allow_files_api": false,
    "issync": false
  },
  "ext": {
    "ct": "2019-08-28T13:34:16.42Z",
    "lwt": "2019-08-28T13:34:16.42Z"
  }
}

Изменение данных канала интеграции

Поля запрещенные для изменения: id, tokenlocal

Запрос

Описание полей: integration_point entity

Пример запроса
PATCH /rest/v1/service/integration_points/b4680fbe-016c-d86f-1d6b-50e54938780c HTTP/1.1
Content-Type: application/json; charset=utf-8

integration_point entity

Ответ

Описание полей: integration_point entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "b4680fbe-016c-d86f-1d6b-50e54938780c",
  "code": "ABCDE",
  "type": "public",
  "token_local": "82ddc7c68623726346a78371173e2f8d",
  "token_remote": "00ea293c29f9dc30",
  "token_remote2": "",
  "url": "http://trapper.com",
  "recv_svcscriptcode": "ws_hook",
  "recv_svcscriptcode_ws": "",
  "send_svcscriptcode": "send_to_web",
  "send_svcscriptcode_ws": "",
  "opts": {
    "title": "",
    "comment": "",
    "allow_files_api": false,
    "issync": false
  },
  "ext": {
    "ct": "2019-08-28T13:34:16.42Z",
    "lwt": "2019-09-10T12:49:25.17Z"
  }
}

Удаление канала интеграции

Запрос

Пример запроса
DELETE /rest/v1/service/integration_points/b4680fbe-016c-d86f-1d6b-50e54938780c HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 204 No Content

Поиск идентификатора канала интеграции

Производит поиск ресурса по указанному ключу, возвращает идентификатор(ы) для построения endpoint.

Ключевые поля для поиска: id, code, tokenlocal

Запрос

Пример запроса
LOOKUP /rest/v1/service/integration_points HTTP/1.1
Content-Type: application/json; charset=utf-8

"82ddc7c68623726346a78371173e2f8d"

Ответ

Пример успешного ответа
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

[
  "b4680fbe-016c-d86f-1d6b-50e54938780c"
]
Пример неуспешного ответа
HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8

{
  "error_code": 1404,
  "error_message": "Lookup failed"
}
  • Персонализация
  • Увеличить шрифт
  • Уменьшить шрифт