Общие сведения
В прикладном решении может быть реализован механизм обработки команд, получаемых от внешнего сервиса.
Примеры команд:
- Создание объектов (документов, справочников)
- Выполнение расчетов
В общем случае процесс отправки команды состоит из следующих шагов:
- Отправка команды запросом –
POST {{baseURL}}/integration/execute → PUT Location - Ожидание выполнения команды запросом –
GET {{baseURL}}/jobs/{id} → GET Location
Если в процессе выполнения команды был создан объект, то информация о нем будет возвращена в результате на 2-м шаге.
Пример использования
Создание платежного поручения с последующим получением запрошенного документа.
Приведенный пример служит в качестве демонстрации и не является законченным решением.
Отправка команды на создание платежного поручения выполняется запросом – POST {{baseURL}}/integration/execute
В результате будет открыто соединение, в ответе будут возвращены Cookie и Location.
По адресу Location выполняется запрос – PUT {Location}. В теле запроса указываются параметры команды.
В примере рассмотрен вариант организации структуры команды для создания документа Платежное поручение.
{
"method": "documents/payment_order/create",
"parameters": {
"amount": 10000,
"account": "40802810900000003155",
"description": "Оплата по первому счету №12345",
"recipient": {
"id": "123456789012",
"name": "ИП Сергиенко Сергей",
"account": "98765432109876543210",
"bank": "044525555"
}
}
}
Дальнейшее отслеживание выполнения команды выполняется с помощью запроса – GET {{baseURL}}/jobs/{id}
В результате выполнения команды могут быть созданы новые объекты. Если объекты созданы, то в результате выполнения задания будет возвращена информация о хранилище данных.
Данные сохраняются в хранилище files, и их можно получить запросом – GET {{baseURL}}/files/{id}
После получения данных выполняется подтверждение получения с помощью запроса – POST {{baseURL}}/integration/confirm