API Роспотребнадзор

Документация по работе с API Роспотребнадзор

Алгоритм получения результата запроса с помощью нашего сервиса достаточно прост и практически одинаков для всех видов ресурсов.
Получите ваш персональный ключ API в настройках вашего аккаунта.
для каждого пользователя генерируется уникальный аутентификационный токен, мы называем "персональный ключ API". Это строка из 32 символов, которая выглядит примерно так:
53ba1b7a55abbа14aa97eff3a5220792
Этот ключ используется для всех ваших запросов к api-cloud.

История изменений/обновлений API

Предупреждение Установите таймаут (TIMEOUT) ожидания минимум 120 секунд, иначе вы можете не получить результат, ваш код может прерваться не дождавшись ответа

HTTPS GET запрос: https://api-cloud.ru/api/rospotrebnadzor.php
Обязательно использовать HTTPS протокол, иначе запросы будут дублироваться при перенаправлении с HTTP на HTTPS.
Обязательно использовать GET запрос, иначе мы не увидим параметры, которые вы передаете.

type Обязательно	Описание	Параметры в запросе Обязательно
	В одном запросе возможно отправить только 1 тип
elmk_registry	Проверка статуса электронных медицинских книжек по данным Единого реестра выданных ЭЛМК	Обязательные elmk_number - номер электронной личной медицинской книжки Маска: [00-00-000000-00] snils - СНИЛС владельца ЭЛМК Маска: [00000000000] token - персональный ключ API

Токен (token) можно передавать в заголовках (headers). Указываем в заголовке Token: ВАШ_ТОКЕН

Пример отправки GET запроса на PHP:

function get_rez($url) {
		$ch = curl_init($url);
		curl_setopt($ch, CURLOPT_RETURNTRANSFER,true);
		curl_setopt($ch,CURLOPT_TIMEOUT,120); // Таймаут необходим, поскольку 30 секунд может не хватить и вы не получите ответ 
		$res = curl_exec($ch);
		curl_close($ch);
		return $res;
	}

  $data = [
    'type' => 'Тип запроса (type)',
    ...
    Необходимы для запроса параметры
    ...
    'token' => 'Токен',
    ];

    // Структурированная ссылка для GET запроса
    $url = 'https://api-cloud.ru/api/rospotrebnadzor.php?' . http_build_query($data);

    $data = get_rez($url); // Результат ответа (JSON)

Сервер вернёт результат обработки или код ошибки, если что-то пошло не так.
Сервер возвращает ответ в формате JSON.

Обратите внимание, что скорость загрузки результата зависит напрямую от ресурса источника
При подсчете количества запросов будут приняты к учету только те запросы, которы вернули "status": 200 и "status": 404, т.е. получили результат.

Максимальное количество попыток соединения 3 раза. Если в результате этих попыток ресурс не вернет ответа, то API CLOUD вернет ответ {"status":404, "error":"TIME_MAX_CONNECT", "errormsg":"Достигнуто максимальное количество коннектов, при которых ресурс не вернул результата"}

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

Проверка статуса электронных медицинских книжек по данным Единого реестра выданных ЭЛМК

Пример запроса "Проверка статуса электронных медицинских книжек по данным Единого реестра выданных ЭЛМК" HTTP GET на URL нашего API

https://api-cloud.ru/api/rospotrebnadzor.php?type=elmk_registry&elmk_number=00-00-000287-23&snils=00000000000&token=53ba1b7a55abbB014aa97eff3a522079

Пример успешного запроса по типу elmk_registry в формате JSON
ЭЛМК есть в реестре

{
  "status": 200, // Статус ответа
  "found": true, // Флаг поиска: true=найдено/false=не найдено
  // Массив с результатами
  "result": {
    "elmk_status_name": "Не действует", // текущий статус ЭЛМК
    "elmk_number": "91-01-000287-23", // номер ЭЛМК
    "first_name": "марина", // имя владельца ЭЛМК
    "last_name": "ж***", //  фамилия владельца ЭЛМК, может быть частично маскирована
    "middle_name": "александровна", // отчество владельца ЭЛМК
    // Массив: перечень видов работ, для которых оформлена книжка.
    "work_type": [
      "Работы в организациях, деятельность которых связана с коммунальным и бытовым обслуживанием населения"
    ],
    "decision_dt": "2024-02-09T09:02:52Z", // дата и время принятия решения по ЭЛМК
    "med_opinions_dt": "2023-12-25", // дата медицинского заключения
    "certification_dt": "2024-02-09", // дата прохождения аттестации
    "recertification_dt": "2026-02-09", // дата очередной переаттестации
    "fbuz_short_name": "ФБУЗ «Центр гигиены и эпидемиологии в Республике Крым и городе федерального значения Севастополе» Ф(ИЛЦ):05.11.112.1.12.23", // наименование учреждения
    "created_fullname": "ЕПГУ" // источник создания записи
  },
  "inquiry": {
    "price": 0.3,
    "balance": 4051.71,
    "credit": 20000,
    "speed": 0,
    "attempts": 1
  }
}

ЭЛМК нет в реестре

{
  "status": 200, // Статус ответа
  "found": false, // Флаг поиска: true=найдено/false=не найдено
  // Пустой массив
  "result": [],
  "inquiry": {
    "price": 0.3,
    "balance": 4051.11,
    "credit": null,
    "speed": 1,
    "attempts": 1
  }
}

История изменений API Роспотребнадзор

дата	что изменилось

Возможные коды ошибок

код (error)	Описание ошибки (message)
rpnz-02	snils not valid Значение параметра snils не соответствует маске
rpnz-01	elmk_number not valid Значение параметра elmk_number не соответствует маске
888	ИМЯ передаваемой переменной: forbidden symbols present В переменной ИМЯ присутствуют запрещенные символы
766	MISSING_MANDATORY_PARAMETER Отсутствуют обязательные параметры
602	TOKEN_NO_ACCESS Нет доступа к запрашиваему методу запроса
504	TOKEN_LOCKED_IN_THE_SYSTEM Переданный токен заблокирован службой качества / автоматической системой
503	TOKEN_NOT_REGISTERED_IN_THE_SYSTEM Переданный токен не зарегистрирован в системе
502	MISSING_REQUIRED_TOKEN_PARAMETER Отсутствует параметр token
500	MISSING_REQUIRED_TYPE_PARAMETER Отсутствует параметр type
5	TEST_TIME_OFF Закончился период тестирования
499	WRONG_TOKEN_KEY Вы указали значение параметра token в неверном формате, ключ должен содержать 32 символа.
498	TOKEN_NO_MONEY Для выполнения запроса недостаточно средств, пополните баланс.
460	NO_REQUIRED_PARAMETERS Отсутствуют обязательные параметры
456	MAX_LIMIT Превышено количество одновременных соединений (потоки)
404	TIME_MAX_CONNECT Достигнуто максимальное количество коннектов, при которых ресурс не вернул результата. Повторите попытку позже.
3	TOKEN_BLOCKED_BY_QUALITY_SERVICE Ваш токен заблокирован службой качества. Свяжитесь с технической поддержкой
2	TOKEN_TEHBLOCK Установлена техническая блокировка токена. Включить или выключить можно самостоятельно в настройках безопасности.
15	DATE_ERROR Ошибка значения переданной даты
123	IP_NOT_REGISTERED_IN_THE_SYSTEM Сработала защита IP. Текущий IP не совпадает с заданным в ЛК
111	PARAMETER_CONFLICT Вы указали параметры, которые конфликтуют между собой. Например VIN и regNumber. Необходимо указать либо VIN либо regNumber, что-то одно.
1	API_SUSPENDED Работа этого API или метода временно приостановлена. Это значит, что источник не отвечает. Мы уже в курсе проблемы и занимаемся решением. Повторите запрос позже.

Пример ответа с ошибкой

{"error":"503","message":"TOKEN_NOT_REGISTERED_IN_THE_SYSTEM"}