---
# System prepended metadata

title: Шаблон обращения к Брокеру
tags: [arithmetic-integration]

---

---
tags: arithmetic-integration
title: Шаблон обращения к Брокеру
---

# Шаблон обращения к Брокеру

[TOC]

## 1. Запрос операции через Брокер

### Request --->

#### URL:
POST http(s)://==server==/==base==/hs/mq/v1/send?apikey===apikey==

#### Headers:
* **apikey**: ==apikey==
* **Content-type**: application/json; charset=utf-8
* **Mq-Jrb-Exchange**: ==exchange-point==
* **Mq-Jrb-Routing-key**: ==routing-key==
* **Mq-Jrb-Operation**: ==operation==
* **Mq-Jrb-Object**: ==object==

:::info
==apikey==: ключ, выданный для интеграции, его можно включить в параметры URL **или** в заголовки запроса
==object==: краткое описание объекта, с которым связаны данные сообщения, например, номер договора или номер телефона клиента
:::

#### Body:
Строка JSON в кодировке UTF-8

---
### Response <---

#### Headers:
* **Mq-Jrb-Id**: ==id==

:::info
==id==: идентификатор сообщения, используемый для последующего получения результата запроса (см. ниже)
:::

#### Body:
Отсутствует

---

## 2. Получение результата из Брокера

### Request --->

#### URL:
GET http(s)://==server==/==base==/hs/mq/v1/result/==id==?apikey===apikey==

#### Headers:
* **apikey**: ==apikey==

:::info
==apikey==: ключ, выданный для интеграции, его можно включить в параметры URL **или** в заголовки запроса
==id==: идентификатор, полученный ранее в ответ при отправке запроса
:::

#### Body:
Отсутствует

### Response <---

#### Headers:
* **Content-type**: application/json; charset=utf-8
* **Mq-Jrb-Id**: ==id==
* **Mq-Jrb-Id-Result**: ==id-result==

:::info
==id==: идентификатор входящего ответного сообщения
==id-result==: идентификатор сообщения, на которое получен этот ответ
:::

#### Body:
Строка JSON в кодировке UTF-8

### Формат ошибочных результатов

Если база Рассрочки не может выполнить операцию по причине некорректных входных данных или по иным причинам, то будет возвращён ошибочный результат с телом следующего вида.

```json
{
	"description": "ru='Описание ошибки'; en='Error description'",
	"error": "ErrorClass.ErrorName"
}
```

---
