API-CLOUD - API РСА (НСИС)
Документация по работе с API РСА (НСИС)

Алгоритм получения результата запроса с помощью нашего сервиса достаточно прост и практически одинаков для всех видов ресурсов.
Получите ваш персональный ключ API в настройках вашего аккаунта.
для каждого пользователя генерируется уникальный аутентификационный токен, мы называем "персональный ключ API". Это строка из 32 символов, которая выглядит примерно так:
53ba1b7a55abbа14aa97eff3a5220792
Этот ключ используется для всех ваших запросов к api-cloud.
Отправьте запрос HTTP GET на URL нашего API: https://api-cloud.ru/api/rsa.php с персональным ключом API и параметрами.
Пример отправки 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/rsa.php?' . http_build_query($data);

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

Сервер вернёт результат обработки или код ошибки, если что-то пошло не так.
Сервер возвращает ответ в формате JSON
История изменений/обновлений API
Предупреждение Установите таймаут (TIMEOUT) ожидания минимум 120 секунд, иначе вы можете не получить результат, ваш код может прерваться не дождавшись ответа
type (Метод) Описание Параметры в запросе
В одном запросе возможно отправить только 1 тип
kbm Проверка КФ бонус/малус (Определить КБМ возможно только для водителей – граждан РФ)
• Вывод коэффициента бонус/малус
Вывод страховых возмещений
Обязательные
surname - Фамилия водителя
Разрешено: кириллица, цифры, знак "-"
name - Имя водителя
Разрешено: кириллица, цифры, знак "-"
birthday - День рождения водителя
В формате 22.12.2020 (дд.мм.гг). Разрешено: цифры, знак "."
driverDocSeries - Серия документа водителя
Разрешено: кириллица, цифры
driverDocNumber - Номер документа водителя
Разрешено: кириллица, цифры
token - персональный ключ API

Дополнительные
patronymic - Отчество водителя
Разрешено: кириллица, латиница, цифры, знак "-"
osago beta Проверка существующих полисов ОСАГО
• Серия ОСАГО
• Номер ОСАГО
• Наименование страховой компании
• Статус договора
• Марка и модель транспортного средства
• Государственный регистрационный знак
• VIN номер
Обязательные
vin - VIN номер или regNumber - регистрационный номер или bodyNumber - номер кузова
Разрешено для VIN: латиница, цифры
Разрешено для regNumber: кириллица, цифры
Разрешено для bodyNumber: латиница, цифры
token - персональный ключ API
Дополнительные
date - на какую дату получить информацию
В формате 22.12.2020 (дд.мм.гг), по умолчанию текущая дата запроса
osagochek beta Проверка полиса ОСАГО по серии и номеру
• Серия ОСАГО
• Номер ОСАГО
• Наименование страховой компании
• Статус договора
• Марка и модель транспортного средства
• Государственный регистрационный знак
• VIN номер
Обязательные
seria - Серия полиса
nomer - Номер полиса
Разрешено для seria: кирилица
Разрешено для nomer: цифры
token - персональный ключ API
Примеры запросов


История изменений API РСА (НСИС)

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

01.10.2024 в тестовом режиме запущены методы osago, osagochek. Получение информации с НСИС.
Методы потерпели небольшие изменения в выводе, актуальная информация в документации.

22.04.2023

Метод запроса kbm: Адаптирован под источник.

14.12.2022

Пересмотрели алгоритм работы с другой стороны. Выявили недочеты, которые в итоге привели к ускорению работы API.

20.11.2022

В результате запроса osagochek добавили массив intelligence с информацией о изменениях полиса ОСАГО.
В документацию внесли изменения.

12.11.2022

В методе запроса osagochek исправили ошибку NO_RESULTAT

07.11.2022

Через метод запроса osago исправили ошибку, связанную с отказом приема свойства regNumber

23.10.2022

В массив inquiry добавили ключ balance. Вывод текущего баланса после запроса, позволит не отправлять дополнительные запросы на проверку баланса. 

10.10.2022

Пофиксили пустой ответ по типу запроса osago

19.09.2022

По типу запроса "osago" поправили ошибку при которой в некоторые моменты возникало отсутствие полиса, при его существовании.

20.07.2022

Исправили работу osagochek. Работает корректно.

19.07.2022

1. Запущена работа в улучшенном алгоритме. Ускорена работа.
2. Вывод из кэша теперь работает только при передаче параметра cache=1
При использовании данного параметра скорость получения ответа может быть уменьшена.

06.07.2022

type->kbm, добавили вывод страховых возмещений.

17.02.2022

Добавлен новый тип запроса "kbmLegal"
Вывод коэффициента бонус/малус юридического лица по ИНН

01.02.2022

type->osago, обязательные параметры
Добавлена проверка на обязательные параметры в запросе. В запросе должны присутствовать обязательные параметры, иначе возникнет ошибка №766 с текстом "MISSING_MANDATORY_PARAMETER"

18.11.2021

ТРЕБУЕТСЯ ДОРАБОТКА ВАШЕГО КОДА
Архитектура ответа type->osago и type->osagochek
Массив с результатами перенесен в переменную rez. Добавлен статус ответа, а так же информация о запросе: Тариф, скорость, количество попыток

26.10.2021

Ошибка type->osago
Из-за нового параметра bodyNumber возникала ошибка PARAMETER_CONFLICT

15.10.2021

Новый параметр поиска в type->osago
Доступен новый параметр bodyNumber для поиска полиса по номеру кузова

09.09.2021

Исправление
Ресурс источник изменил формат ответа. API приведен в соответствие.

06.09.2021

Описание новой ошибки
При возникновении проблем с ресурсом источником API отключается до решения вопроса по его восстановлению. В данном случае ответ: {"error":001,"message":"API_SUSPENDED","errormsg":"Работа этого API временно приостановлена. Мы уже в курсе проблемы и занимаемся решением. Повторите запрос позже."}

19.08.2021

Отловлен баг с пустым ответом ресурса в связи с загруженностью.
Проводятся дополнительные попытки получить ответ, если по истечению попыток результата нет, то возникает ошибка {"error":404,"message":"NO_RESULTAT","errormsg":"Ресурс не вернул никакого результата. Повторите запрос."}.
Средства возвращаются на баланс.

29.07.2021

1. Пофиксили баг, который возникал когда в РСА присутствовало более 1 активного полиса
2. В вывод добавили параметр maxMassa - Максимальная разрешенная масса для категории С, кг

23.07.2021

Добавили новый тип запроса type -> osagochek
Позволяет произвести поиск по серии и номеру полиса ОСАГО

22.07.2021

Переделали алгоритм запроса данных. Увеличили скорость ответа.

03.06.2021

При запросе type -> osago добавили вывод результата в случае отсутствия информации о полисе
{"status":200,"count":0,"message":"Сведения о договоре ОСАГО с указанными данными не найдены"}

21.05.2021

Пофиксили вывод результата type=osago. Ранее если был номер кузова указан или отсутствовала мощность, то весь запрос выводился некорректно. Переделали архитектуру.
Добавили параметр вывода: numberID - номер полиса, kuzovNumber - номер кузова (если указан)

11.05.2021

В type=osago добавлен параметр regNumber. Поиск по регистрационному номеру ТС

07.05.2021

1. Пофиксили пустой ответ []
2. Пофиксили вывод после VIN номера. Обнаружили дополнительное поле "Номер кузова, которое сбивало вывод"

17.04.2021

Добавили проверку доступности сервиса решения капч. Если сервис недоступен, то средства за запрос не снимаются. Вы сможете отправить запрос позднее, когда сервис будет вновь доступен.
Код ошибки: 999. SERVICE_CAPTCHA_OFFLINE

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

код (error) Описание ошибки (message)
888 ИМЯ передаваемой переменной: forbidden symbols present
В переменной ИМЯ присутствуют запрещенные символы
784 MISSING_REQUIRED_INN_PARAMETER
Отсутствует параметр inn или указан неверно
766 MISSING_MANDATORY_PARAMETER
Отсутствуют обязательные параметры
708 patronymic: forbidden symbols present
В параметре patronymic присутствуют запрещенные символы
707 name: forbidden symbols present
В параметре name присутствуют запрещенные символы
706 surname: forbidden symbols present
В параметре surname присутствуют запрещенные символы
705 MISSING_REQUIRED_DRIVERDOCNUMBER_PARAMETER
Отсутствует параметр driverDocNumber (Номер удостоверения водителя)
704 MISSING_REQUIRED_DRIVERDOCSERIES_PARAMETER
Отсутствует параметр driverDocSeries (Серия удостоверения водителя)
703 MISSING_REQUIRED_BIRTHDAY_PARAMETER
Отсутствует параметр BIRTHDAY (День рождения)
702 MISSING_REQUIRED_PATRONYMIC_PARAMETER
Отсутствует параметр PATRONYMIC (Отчество)
701 MISSING_REQUIRED_NAME_PARAMETER
Отсутствует параметр NAME (Имя)
700 MISSING_REQUIRED_SURNAME_PARAMETER
Отсутствует параметр SURNAME (Фамилия)
602 TOKEN_NO_ACCESS
Нет доступа к запрашиваему методу запроса
505 MISSING_REQ_REGNUM_STS_PARAM
Отсутствует обязательная связка параметров Регистрационный номер (regNumber) и/или Номер СТС (stsNumber)
504 TOKEN_LOCKED_IN_THE_SYSTEM
Переданный токен заблокирован службой качества / автоматической системой
503 TOKEN_NOT_REGISTERED_IN_THE_SYSTEM
Переданный токен не зарегистрирован в системе
502 MISSING_REQUIRED_TOKEN_PARAMETER
Отсутствует параметр token
501 MISSING_REQUIRED_SERIA-NOMER_PARAMETER
Отсутствует параметр seria/nomer или указан неверно
500 MISSING_REQUIRED_TYPE_PARAMETER
Отсутствует параметр type
499 WRONG_TOKEN_KEY
Вы указали значение параметра token в неверном формате, ключ должен содержать 32 символа.
498 TOKEN_NO_MONEY
Для выполнения запроса недостаточно средств, пополните баланс.
460 NO_REQUIRED_PARAMETERS
Отсутствуют обязательные параметры
456 MAX_LIMIT
Превышено количество одновременных соединений (потоки)
404 TIME_MAX_CONNECT
Достигнуто максимальное количество коннектов, при которых ресурс не вернул результата. Повторите попытку позже.
123 IP_NOT_REGISTERED_IN_THE_SYSTEM
Сработала защита IP. Текущий IP не совпадает с заданным в ЛК
111 PARAMETER_CONFLICT
Вы указали параметры, которые конфликтуют между собой. Например VIN и regNumber. Необходимо указать либо VIN либо regNumber, что-то одно.
015 DATE_ERROR
Ошибка значения переданной даты
005 TEST_TIME_OFF
Закончился период тестирования
003 TOKEN_BLOCKED_BY_QUALITY_SERVICE
Ваш токен заблокирован службой качества. Свяжитесь с технической поддержкой
002 TOKEN_TEHBLOCK
Установлена техническая блокировка токена. Включить или выключить можно самостоятельно в настройках безопасности.
001 API_SUSPENDED
Работа этого API временно приостановлена. Мы уже в курсе проблемы и занимаемся решением. Повторите запрос позже.
Пример ответа с ошибкой

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