Dispensary Service

Описание

Dipsensary Service - это сервис-интеграция с Egov предназначенный для мониторинга регистрационного статуса человека в наркологических, психоневрологических и противотуберкулезных диспансерах.

Для комфортной интеграции через Backend API воспользуйтесь Swagger (OpenAPI)

---

Термины

• Субъект - это человек, который является объектом запроса на проверку в диспансерах.
• ИИН - индивидуальный идентификационный номер гражданина Республики Казахстан.

Этапы:

1. Получение API-KEY организации

Первый этап для использования технологии - получение API-KEY организации. Чтобы получить API-KEY организации, необходимо зайти в Личный Кабинет по данной ссылке. API-KEY находится в поле Backend Api Key

Пример API-KEY организации:

API-KEY: Efy202XKbVAWRu...

Примечание

Для наглядности используется укороченная длина API KEY. Его фактическая длина составляет 47 и более символов.

2. Отправка запроса на получение информации о посещениях диспансеров

При отправке запроса используются данные в формате JSON.

Важно

Чтобы использовать данный сервис, необходимо иметь на него подписку. Подробнее о подписках можно прочитать здесь.

URL запроса:

https://kyc.biometric.kz/api/v1/backend/dispensary/check/

Формат запроса	Метод запроса
JSON	POST

API KEY необходимо передать в теле запроса:

Наименование поля	Тип	Обязательно	Описание
api_key	String	Да	API KEY организации в личном кабинете
iin	String	Да	ИИН субъекта

Примеры запроса:

cURLPythonJavaScript

curl --location --request POST 'https://kyc.biometric.kz/api/v1/backend/dispensary/check/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "api_key": "<organization_api_key>",
    "iin": "<subjects_iin>",
}'

import requests
import json

url = "https://kyc.biometric.kz/api/v1/backend/dispensary/check/"

payload = json.dumps({
  "api_key": "<organization_api_key>",
  "iin": "<subjects_iin>"
})
headers = {
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.json())

let myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

let raw = JSON.stringify({
  "api_key": "<organization_api_key>",
  "iin": "<subjects_iin>"
});

let requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://kyc.biometric.kz/api/v1/backend/dispensary/check/", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

В качестве ответа придет JSON со следующими полями:

• dispensary_result - JSON-объект с информацией о посещениях субъектом диспансеров
• failure_reason - причина провала поиска информации.

Пример ответа:

{
  "dispensary_result": {
    "narcological_account": {
      "RU": "Не состоит на учете в наркологической организации",
      "KZ": "Наркологиялық ұйымда диспансерлік есепте тұрмайды"
    },
    "psychoneurological_account": {
      "RU": "Не состоит на учете в психоневрологической организации",
      "KZ": "Психоневрологиялық ұйымда диспансерлік есепте тұрмайды"
    },
    "antitubercular_account": {
      "RU": "Не состоит на учете в противотуберкулезной организации",
      "KZ": "Туберкулезге қарсы ұйымда диспансерлік есепте тұрмайды"
    }
  },
  "failure_reason": null
}

Ошибки

Код состояния	Ответ	Описание
409	Could not send request to dispensary service	Не удалось отправить запрос на сервис dispensary
400	Subscription has not started	Подписка еще не активировалась
400	No active or future subscription for technology	Нет активной или будущей подписки на технологию
400	Client does not have subscription	У клиента отсутствует подписка, подробнее о подписках можно прочитать здесь
400	Could not connect to dispensary service	Не удалось установить соединение с сервисом dispensary