Callback запросы¶
Callback запросы — это асинхронные ответы от МедМи API (ИИС), которые доставляются на клиентский сервис клиники (МИС) после обработки API запросов. Инициатором callback-запроса выступает МедМи API (ИИС).
Общий принцип работы¶
- МИС (клиника) отправляет API запрос (например,
RegisterDocument,DemandContent) - МедМи API (ИИС) обрабатывает запрос и взаимодействует с РЭМД
- МедМи API (ИИС) отправляет callback-запрос на клиентский сервис клиники с результатом обработки
- МИС (клиника) должна вернуть
200 OKв ответ на callback-запрос
Общие параметры callback-запроса¶
Все callback-запросы используют одинаковые заголовки:
| Заголовок | Описание | Обязательный |
|---|---|---|
businessId |
Идентификатор бизнеса в системе gbooking | ✅ |
user |
Имя/ключ пользователя | ✅ |
token |
Токен доступа | ✅ |
Общие параметры callback-ответа¶
| Параметр | Тип | Описание |
|---|---|---|
status |
enum | Статус ответа: Success или Error |
businessId |
integer (int64) | Идентификатор бизнеса в системе gbooking |
queueMessageId |
string (uuid) | Уникальный id сообщения, связанного с исходным API запросом |
clientMessageId |
string (uuid) | Уникальный пользовательский id, установленный в исходном API запросе |
errors |
array | Список ошибок (при status: Error) |
warnings |
array | Список замечаний |
Ожидаемый ответ от МИС (клиники)¶
На каждый callback-запрос клиентский сервис клиники должен вернуть HTTP 200 с телом:
{
"status": "Success"
}
Если клиентский сервис клиники не вернёт 200, МедМи API (ИИС) будет повторять отправку callback-запроса.
Доступные Callback методы¶
| Метод | Описание | Родительский API запрос |
|---|---|---|
| SendRegisterDocumentResponse | Результат приёмки запроса регистрации | RegisterDocument |
| SendRegisterDocumentResultResponse | Результат регистрации документа в РЭМД | RegisterDocument |
| SendSearchRegistryItemResponse | Результат поиска записей в реестре | SearchRegistryItem |
| SendGetRegistryItemResponse | Результат получения регистрационных сведений | GetRegistryItem |
| SendGetMetadataResponse | Результат получения метаописания ЭМД | GetMetadata |
| SendDemandContentResponse | Результат приёмки запроса файла документа | DemandContent |
| SendDocumentFileResultResponse | Передача файла ЭМД из архива предоставляющей МИС | DemandContent |
Примечание
Каждый API запрос может порождать один или несколько callback-запросов. Например, RegisterDocument порождает два callback: SendRegisterDocumentResponse (результат приёмки) и SendRegisterDocumentResultResponse (результат регистрации). А DemandContent порождает SendDemandContentResponse (результат приёмки) и SendDocumentFileResultResponse (файл документа).
Полное описание параметров всех callback методов доступно в Swagger.