Регистрация участника ИО в системе «Вычеты»

Инициатор вызова: участник ИО.

Процедура вызывается для прохождения регистрации/уточнении сведений о контактном лице участником ИО в системе «Вычеты».

В качестве формата обмена данными используются JSON, XML и бинарные файлы, передаваемые в сообщениях, которые кодируются в формате BASE64.

URL: /taxbenefits/v1/registration

Method: POST

Запрос (PostPartnerRegistrationRequest)

Содержание	Тип	Обязательность	Описание
contentBase64	String, Base64	Обязательно	XML файл-сообщение об информационном обмене для упрощенной процедуры получения налоговых вычетов

Ответ (PostPartnerRegistrationResponse)

Содержание	Тип	Обязательность	Описание
requestId	String	Обязательно	Идентификатор сообщения. Совпадает с X-Request_Id указанным при создании запроса со стороны участника ИО или назначается системой автоматически, если X-Request_Id не был указан
status	String	Обязательно	Статус обработки запроса. Возможные значения: OK – участник ИО успешно зарегистрирован или информация о нем обновлена. ERROR – ошибка при регистрации
message	String	Обязательно	Дополнительная информация о результатах обработки запроса
acknowledgeTime	String	Не обязательно	Дата получения запроса
error	Struct	Не обязательно	Обязательно при значении атрибута status = ERROR
· code	String	Обязательно	Код ошибки
· message	String	Обязательно	Описание ошибки
· additionalInfo	Struct, string	Не обязательно	Набор дополнительных атрибутов ошибки. Может быть использован для составления более детального запроса в службу технической поддержки. Пример: "additionalInfo": { "tpFio": "Иванов Иван Иванович", "tpInn": "5212345678" }

Бизнес-логика

Запрос направляется в систему «Вычеты» с использованием технологии синхронного взаимодействия. Описание схемы взаимодействия при регистрации участника ИО в системе «Вычеты» представлено на рисунке 1.

Участники информационного обмена используют POST метод с URL /taxbenefits/v1/registration. В заголовке REST запроса указывается токен доступа, полученный в запросе 1.1. Аутентификация участника ИО в системе «Вычеты», а также опционально может указываться сформированный на стороне участника ИО X-Request-Id. Участник ИО формирует payload в формате xml, предусмотренном xsd-схемой документа (сообщение об информационном обмене для упрощенной процедуры получения налоговых вычетов). Сформированный xml документ кодируется в формат base64. Затем полученное значение вкладывается в запрос / taxbenefits / v 1/ registration согласно формату, описываемому в данном пункте.

В «Открытых API» проводится контроль согласно разделу 1.2. Проверка токена участника ИО.

Запрос с положительным результатом проверки токена передается через очередь запросов в систему «Вычеты» для проведения следующих проверок по приему документа:

1. Форматно-логический контроль документа на соответствие утвержденной xsd-схеме.

Если запрос не прошел валидацию, тогда результат проверки сохраняется в логах. В ответ участнику ИО передается сообщение формата:

{

"requestId": "4ad76228-517f-4496-aa6c-eef36d3de35a",

"status": "ERROR",

"message": null,

"acknowledgeTime": null,

"error": {

"code": "application.xsd.failed",

"message": "Документ из запроса не прошел контроль по XSD схеме",

"additionalInfo": {

"cvc-pattern-valid": "Value '77918276256' is not facet-valid with respect to pattern '([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}' for type 'ИННЮЛТип'."

}

}

}

Если передан валидный документ, то сертификат открытой части ключа, который включен в документ, сохраняется в системе «Вычеты» для дальнейшего использования при проверке данных отправителя при отправке запроса на осуществление налогового вычета. Сертификат открытой части ключа будет использоваться при проверке данных отправителя в последующих взаимодействиях.

2. Бизнес проверки содержимого документа

В ходе этих проверок могут быть выявлены следующие ошибки:

- Бизнес-ошибки. Пример сообщения:

{

"requestId": "4ad76228-517f-4496-aa6c-eef36d3de35a",

"status": "ERROR",

"message": null,

"acknowledgeTime": "2020-09-02T23:21:02.646+03:00",

"error": {

"code": "ERR_INTERNAL",

"message": "Ошибка идентификации в ПОН ИЛ",

"additionalInfo": {}

}

}

- Внутренние ошибки системы «Вычеты»

В случаи недоступности системы «Вычеты» необходимо перенаправить запрос в систему. Участник ИО считается не зарегистрированным вплоть до получения положительного результата регистрации.

Если проверки пройдены успешно, то данные документа сохраняются в системе «Вычеты» для последующей обработки.

Если документ отправляется участником ИО повторно, тогда данные о нем в системе «Вычеты» будут заменены на последние отправленные и при регистрации.

В ответ участник ИО получает ответ, согласно описанному выше формату. Пример ответа:

{

"requestId": "4ad76228-517f-4496-aa6c-eef36d3de35a",

"status": "OK",

" message ": "НА зарегистрирован",

"acknowledgeTime": "2020-09-02T23:21:02.646+03:00",

"error": null

}

Рисунок 1 – Схема взаимодействия при регистрации участника ИО в системе «Вычеты»

Важно! Данный запрос является синхронным и участнику ИО нет необходимости по requestId получать статус обработки запроса на регистрацию участника ИО через метод 2.3. Запрос результата проверки документов от участника ИО в системе «Вычеты».