Описание методов API сервиса МЧД.МИГ24
Презентация возможностей API сервиса сервиса https://m4d.mig24.ru/api
Тестовая среда - https://test-mchd.ntssoft.ru/
Тестовый ЦПРР - https://mcd.cprr-it.weintegrator.com/emchd
Тестовый Swagger
https://test-mchd.ntssoft.ru/api-docs или https://test-mchd.ntssoft.ru/api-doc.html
Получение тестовой КЭП https://testca2012.cryptopro.ru/UI/Default.aspx
Запрос вашего код авторизации АПИ - info@mig24.ru
Telegram поддержки https://t.me/NTSsupport
Продуктовая среда - https://m4d.mig24.online/
Продуктовый Swagger
https://m4d.mig24.online/api-docs или https://m4d.mig24.online/api-doc.html
Тестовая среда - https://test-mchd.ntssoft.ru/
Тестовый ЦПРР - https://mcd.cprr-it.weintegrator.com/emchd
Тестовый Swagger
https://test-mchd.ntssoft.ru/api-docs или https://test-mchd.ntssoft.ru/api-doc.html
Получение тестовой КЭП https://testca2012.cryptopro.ru/UI/Default.aspx
Запрос вашего код авторизации АПИ - info@mig24.ru
Telegram поддержки https://t.me/NTSsupport
Продуктовая среда - https://m4d.mig24.online/
Продуктовый Swagger
https://m4d.mig24.online/api-docs или https://m4d.mig24.online/api-doc.html
Авторизация
Для доступа к сервису необходимо указать следующий заголовок:
Authorization: Bearer <token>
Запросить token можно через info@mig24.ru или в Telegram https://t.me/NTSsupport
Предоставление доступа осуществляется на платной основе. При окончании оплаченного срока доступа авторизация возвращает ошибку: "Оплаченный срок доступа истек".
Authorization: Bearer <token>
Запросить token можно через info@mig24.ru или в Telegram https://t.me/NTSsupport
Предоставление доступа осуществляется на платной основе. При окончании оплаченного срока доступа авторизация возвращает ошибку: "Оплаченный срок доступа истек".
Асинхронные методы работы с сервисом
Асинхронные методы работы с сервисом
Общее описание работы асинхронных методов.
В приложении есть очереди запросов requests и ответов responses.
Пользователь отправляет запрос /api/requests с указанием самостоятельно сгенерированным идентификатора запроса requestId, указывает тип запроса requestType:
Если запрос был отклонен приложением, то пользователь получает отказ, корректирует запрос и отправляет снова.
Если запрос был принят (code 200), то он добавляется в очередь запросов, затем в очередь ответов добавляется ответ со статусом подтверждения начала обработки запроса со статусом AWAIT_SENDING_TO_CPRR (ОЖИДАНИЕ ПЕРЕДАЧИ ЗАПРОСА).
Далее, после обработки в ИС хранения, будет добавлены остальные ответы с соответствующими статусами.
После успешной отправки асинхронного запроса в сервис пользователю необходимо:
Mchd - регистрация МЧД
Для запроса загрузки МЧД остановка работы запроса заканчивается при получении одного из следующих статусов: CREATED (ЗАРЕГИСТРИРОВАНА), ACTIVE (АКТИВНА), REJECTED (ОТКАЗ В РЕГИСТРАЦИИ), REVOKED (ОТМЕНЕНА), EXPIRED (ДЕЙСТВИЕ ИСТЕКЛО).
Revocation - отмена МЧД
Для запроса загрузка заявления на отмену остановка работы запроса произойдет при получении одного из следующих статусов: REJECTED (ОТКАЗ В РЕГИСТРАЦИИ), REVOKED (ОТМЕНЕНА), EXPIRED (ДЕЙСТВИЕ ИСТЕКЛО).
GetStatus - получение статуса МЧД
Работа запроса на однократное получение статуса по номеру МЧД будет остановлена после получения статуса. В очередь ответов будет добавлен соответствующий ответ.
Возможные статусы МЧД:
Любой запрос, по которому пришел ответ - ошибка, будет остановлен. Содержание ошибки будет предоставлено в ответе в виде строки json или в виде строки текста, если получен не json.
GetMchd - получение архива с файлами МЧД
При запросе архива МЧД - когда архив МЧД готов к скачиванию, то возвращается ответ со статусом READY_FOR_DOWNLOAD - ГОТОВА ДЛЯ СКАЧИВАНИЯ.
В ответе присутствуют ContentType и MchdFileId
Чтобы скачать файл следует использовать синхронный метод /api/m4d/files/{mchdFileId}
Чтобы получить только полномочия и статус (не скачивая архив) следует использовать синхронный метод /api/m4d/powers/{mchdFileId}
В случае, если такой МЧД нет в ИС хранения, то вернется NOT_FOUND - НЕ НАЙДЕНА.
Пример архива с файлами МЧД
SubscribeStatus - Подписка на состояние статуса МЧД
Можно добавить в сервис подписки любую МЧД.
Потребуется ее номер и место хранения.
После начала подписки сразу будет возвращен текущий статус МЧД.
Далее сервис самостоятельно следит за статусом этой МЧД в месте ее хранения и при любом его (статусе) изменении формирует для инициатора подписки соответствующее сообщение с новым статусом.
Подписка на МЧД отменяется автоматически при получении статусов "Отменена", "Отказ в регистрации" или "Действие истекло".
Данный функционал призван существенно снизить необходимость постоянно опроса статусов МЧД из системы, где они проверяются и используются и получать только сообщения, когда статус действительно изменился.
Отправить запрос для МЧД из сервиса - /api/requests/send-created
Отправляет запрос на выполнение нужного действия для МЧД, созданной в сервисе.
mchdInfoId - Идентификатор МЧД в сервисе
requestType - Тип запроса: Mchd
Метод работает пока только для МЧД СФР. Результат выполнения метода можно получить запросив актуальный статус МЧД в сервисе.
В приложении есть очереди запросов requests и ответов responses.
Пользователь отправляет запрос /api/requests с указанием самостоятельно сгенерированным идентификатора запроса requestId, указывает тип запроса requestType:
- Mchd- регистрация МЧД
- Revocation - отмена МЧД
- GetStatus - получение статуса МЧД
- GetMchd - получение архива с файлами МЧД
- SubscribeStatus - Подписка на состояние статуса МЧД
- CPRR -ЦПРР ФНС
- MIG24 - МЧД.МИГ24
- SFR - Социальный Фонд России
Если запрос был отклонен приложением, то пользователь получает отказ, корректирует запрос и отправляет снова.
Если запрос был принят (code 200), то он добавляется в очередь запросов, затем в очередь ответов добавляется ответ со статусом подтверждения начала обработки запроса со статусом AWAIT_SENDING_TO_CPRR (ОЖИДАНИЕ ПЕРЕДАЧИ ЗАПРОСА).
Далее, после обработки в ИС хранения, будет добавлены остальные ответы с соответствующими статусами.
После успешной отправки асинхронного запроса в сервис пользователю необходимо:
- получить список идентификаторов на свои ответы, которые не помечены как удаленные из очереди ответов /api/responses
- по идентификатору ответа получить все соответствующие данные /api/responses/{responseId}
- отметить запрос удаленным из очереди ответов /api/responses/{responseId}.
Mchd - регистрация МЧД
Для запроса загрузки МЧД остановка работы запроса заканчивается при получении одного из следующих статусов: CREATED (ЗАРЕГИСТРИРОВАНА), ACTIVE (АКТИВНА), REJECTED (ОТКАЗ В РЕГИСТРАЦИИ), REVOKED (ОТМЕНЕНА), EXPIRED (ДЕЙСТВИЕ ИСТЕКЛО).
Revocation - отмена МЧД
Для запроса загрузка заявления на отмену остановка работы запроса произойдет при получении одного из следующих статусов: REJECTED (ОТКАЗ В РЕГИСТРАЦИИ), REVOKED (ОТМЕНЕНА), EXPIRED (ДЕЙСТВИЕ ИСТЕКЛО).
GetStatus - получение статуса МЧД
Работа запроса на однократное получение статуса по номеру МЧД будет остановлена после получения статуса. В очередь ответов будет добавлен соответствующий ответ.
Возможные статусы МЧД:
AWAIT_SENDING_TO_CPRR - ОЖИДАНИЕ ПЕРЕДАЧИ ЗАПРОСА
SEND_TO_CPRR - ЗАПРОС ПЕРЕДАН
SEND_TO_CPRR_ERROR - ОШИБКА ПРИЕМА ЗАПРОСА
PROCESSING - ОЖИДАНИЕ ПОДТВЕРЖДЕНИЯ
REJECTED- ОТКАЗ В РЕГИСТРАЦИИ
CREATED - ЗАРЕГИСТРИРОВАНА
ACTIVE - АКТИВНА
REVOKED - ОТМЕНЕНА
EXPIRED - ДЕЙСТВИЕ ИСТЕКЛО
UNDEFINED - НЕОПРЕДЕЛЕН
Любой запрос, по которому пришел ответ - ошибка, будет остановлен. Содержание ошибки будет предоставлено в ответе в виде строки json или в виде строки текста, если получен не json.
GetMchd - получение архива с файлами МЧД
При запросе архива МЧД - когда архив МЧД готов к скачиванию, то возвращается ответ со статусом READY_FOR_DOWNLOAD - ГОТОВА ДЛЯ СКАЧИВАНИЯ.
В ответе присутствуют ContentType и MchdFileId
Чтобы скачать файл следует использовать синхронный метод /api/m4d/files/{mchdFileId}
Чтобы получить только полномочия и статус (не скачивая архив) следует использовать синхронный метод /api/m4d/powers/{mchdFileId}
В случае, если такой МЧД нет в ИС хранения, то вернется NOT_FOUND - НЕ НАЙДЕНА.
Пример архива с файлами МЧД
SubscribeStatus - Подписка на состояние статуса МЧД
Можно добавить в сервис подписки любую МЧД.
Потребуется ее номер и место хранения.
После начала подписки сразу будет возвращен текущий статус МЧД.
Далее сервис самостоятельно следит за статусом этой МЧД в месте ее хранения и при любом его (статусе) изменении формирует для инициатора подписки соответствующее сообщение с новым статусом.
Подписка на МЧД отменяется автоматически при получении статусов "Отменена", "Отказ в регистрации" или "Действие истекло".
Данный функционал призван существенно снизить необходимость постоянно опроса статусов МЧД из системы, где они проверяются и используются и получать только сообщения, когда статус действительно изменился.
Отправить запрос для МЧД из сервиса - /api/requests/send-created
Отправляет запрос на выполнение нужного действия для МЧД, созданной в сервисе.
mchdInfoId - Идентификатор МЧД в сервисе
requestType - Тип запроса: Mchd
Метод работает пока только для МЧД СФР. Результат выполнения метода можно получить запросив актуальный статус МЧД в сервисе.
Cписок идентификаторов из очереди своих ответов
Результат: 200 OK
[ {
"ResponseId": "1e56ed98-6f52-4f62-a094-91cade25a7c3",
"RequestId": "3810804e-5452-448c-9b0e-539650e798fa",
"CreationDateTime": "2023-09-05 09:07:07.679847"},
{
"ResponseId": "4b10d531-ac8a-4139-a50d-34a32df5b7a0",
"RequestId": "3810804e-5452-448c-9b0e-539650e798fa",
"CreationDateTime": "2023-09-05 09:07:45.135923" },
{
"ResponseId": "b7ef3d70-9500-4a69-9d6c-a27157f18e48",
"RequestId": "e6c716a5-3023-4e00-abc1-d31fe86ae861",
"CreationDateTime": "2023-09-05 09:38:15.190263" },
... ]
[ {
"ResponseId": "1e56ed98-6f52-4f62-a094-91cade25a7c3",
"RequestId": "3810804e-5452-448c-9b0e-539650e798fa",
"CreationDateTime": "2023-09-05 09:07:07.679847"},
{
"ResponseId": "4b10d531-ac8a-4139-a50d-34a32df5b7a0",
"RequestId": "3810804e-5452-448c-9b0e-539650e798fa",
"CreationDateTime": "2023-09-05 09:07:45.135923" },
{
"ResponseId": "b7ef3d70-9500-4a69-9d6c-a27157f18e48",
"RequestId": "e6c716a5-3023-4e00-abc1-d31fe86ae861",
"CreationDateTime": "2023-09-05 09:38:15.190263" },
... ]
Параметры асинхронных запросов
Регистрация МЧД или заявления на отмену в ЦПРР
requestId - Идентификатор запроса
requestType -Тип запроса: Mchd (загрузка МЧД), Revocation (загрузка заявления на отмену) svedSyst -Информационная система хранения: CPRR, MIG24
files - xml файл МЧД или заявления на отмену МЧД
files - sig файл подписи МЧД или заявления на отмену МЧД
Номер МЧД будет получен из загруженного xml файла.
Получение статуса (разовый)
requestId - Идентификатор запроса
requestType - Тип запроса: GetStatus (получить статус)
svedSyst - Информационная система хранения: CPRR, MIG24
mchdNumber - Номер МЧД
Получение файла архива МЧД
requestId - Идентификатор запроса
requestType - Тип запроса: GetMchd (получить файла архива МЧД)
svedSyst - Информационная система хранения: CPRR, MIG24
mchdNumber - Номер МЧД
issuerInn - ИНН Доверителя
representativeInn - ИНН уполномоченного
requestId - Идентификатор запроса
requestType -Тип запроса: Mchd (загрузка МЧД), Revocation (загрузка заявления на отмену) svedSyst -Информационная система хранения: CPRR, MIG24
files - xml файл МЧД или заявления на отмену МЧД
files - sig файл подписи МЧД или заявления на отмену МЧД
Номер МЧД будет получен из загруженного xml файла.
Получение статуса (разовый)
requestId - Идентификатор запроса
requestType - Тип запроса: GetStatus (получить статус)
svedSyst - Информационная система хранения: CPRR, MIG24
mchdNumber - Номер МЧД
Получение файла архива МЧД
requestId - Идентификатор запроса
requestType - Тип запроса: GetMchd (получить файла архива МЧД)
svedSyst - Информационная система хранения: CPRR, MIG24
mchdNumber - Номер МЧД
issuerInn - ИНН Доверителя
representativeInn - ИНН уполномоченного
Параметры ответов со статусами обработки асинхронных запросов
Первоначально в очередь ответов будет добавлен ответ со статусом AWAIT_SENDING_TO_CPRR (ОЖИДАНИЕ ПЕРЕДАЧИ ЗАПРОСА В СИСТЕМУ ХРАНЕНИЯ)
Затем после обработки в системе хранения будет добавлены остальные ответы с другими статусами.
Примеры:
{
"ResponseId": "1e56ed98-6f52-4f62-a094-91cade25a7c3",
"RequestId": "3810804e-5452-448c-9b0e-539650e798fa",
"CreationDateTime": "2023-09-05 10:07:07.679847",
"RequestType": "Revocation",
"HttpCode": null,
"ErrorMessage": null,
"MchdNumber": "341c00d4-8a27-4166-83c2-d7e4b3bdbd36",
"MchdStatus": "AWAIT_SENDING_TO_CPRR",
"MchdStatusRus": "ОЖИДАНИЕ ПЕРЕДАЧИ ЗАПРОСА В СИСТЕМУ ХРАНЕНИЯ",
"ContentType": null,
"MchdFileId": null,
"IsDeleted": false }
{
"ResponseId": "4b10d531-ac8a-4139-a50d-34a32df5b7a0",
"RequestId": "3810804e-5452-448c-9b0e-539650e798fa",
"CreationDateTime": "2023-09-05 10:07:45.135923",
"RequestType": "Mchd",
"HttpCode": 400,
"ErrorMessage": "{\"type\":\"/errors/poa.issuer_signer_mismatch_with_egrul\",\"title\":\"Данные доверителя и подписанта в доверенности не соответствуют данным из ЕГРЮЛ\",\"status\":400,\"detail\":\"\",\"instance\":\"/api/v0/poar-webapp/integration/poa\",\"meta\":null}",
"MchdNumber": "8aa00a0b-dea6-42f9-a0c2-89b3269be1c5",
"MchdStatus": "SEND_TO_CPRR_ERROR",
"MchdStatusRus": "ОШИБКА ПРИЕМА ЗАПРОСА В СИСТЕМУ ХРАНЕНИЯ",
"ContentType": null,
"MchdFileId": null,
"IsDeleted": true }
{
"ResponseId": "6a86045b-450d-4e91-8556-6b331dae0f3c",
"RequestId": "6b3e566f-f850-4410-9220-e4dc03eb1d32",
"CreationDateTime": "2023-09-05 10:49:05.657741",
"RequestType": "GetStatus",
"HttpCode": 200,
"ErrorMessage": null,
"MchdNumber": "31ec16d8-2b52-4855-879b-b6a128972d62",
"MchdStatus": "PROCESSING",
"MchdStatusRus": "ОЖИДАНИЕ ПОДТВЕРЖДЕНИЯ",
"ContentType": null,
"MchdFileId": null,
"IsDeleted": false }
{
"ResponseId": "6a86045b-450d-4e91-8556-6b331dae0f3c",
"RequestId": "2477cdf9-6f79-42fc-ba16-c9721cf88a91",
"CreationDateTime": "2023-09-05 10:49:05.657741",
"RequestType": "GetMchd",
"HttpCode": 200,
"ErrorMessage": null,
"MchdNumber": "31ec16d8-2b52-4855-879b-b6a128972d62",
"MchdStatus": "PROCESSING",
"MchdStatusRus": "ОЖИДАНИЕ ПОДТВЕРЖДЕНИЯ",
"ContentType": null,
"MchdFileId": null,
"IsDeleted": false }
{
"ResponseId": "c878514d-0cf6-4882-a536-2eb2b384b81a",
"RequestId": "030f6e4c-94a5-403f-8132-2a69a27822ee",
"CreationDateTime": "2024-01-26 11:20:59.957509",
"RequestType": "GetMchd",
"SvedSyst": "CPRR",
"HttpCode": 200,
"ErrorMessage": null,
"MchdNumber": "e5d9cc1b-5386-4897-ad17-bde537562d02",
"MchdStatus": "READY_FOR_DOWNLOAD",
"MchdStatusRus": "ГОТОВА ДЛЯ СКАЧИВАНИЯ",
"ContentType": "application/zip",
"MchdFileId": "10eb821c-2ca3-4d2a-b5a2-9672254a50e2",
"IsDeleted": false }
Затем после обработки в системе хранения будет добавлены остальные ответы с другими статусами.
ResponseId - Идентификатор ответа
RequestId - Идентификатор запроса
CreationDateTime - Дата и время UTCв формате [yyyy-MM-dd HH:mm:ss.ffffff]
RequestType - Тип запроса: Mchd, Revocation, GetStatus
HttpCode - Код ответа из ЦПРР
ErrorMessage - Ошибка из ЦПРР
MchdNumber - Номер МЧД
MchdStatus - Статус ответа
MchdStatusRus - Статус ответа на русском языке
ContentType - Тип контента (application/zip)
MchdFileId - Идентификатор файла архив МЧД
IsDeleted - Отмечен удаленным из очереди ответов
Примеры:
{
"ResponseId": "1e56ed98-6f52-4f62-a094-91cade25a7c3",
"RequestId": "3810804e-5452-448c-9b0e-539650e798fa",
"CreationDateTime": "2023-09-05 10:07:07.679847",
"RequestType": "Revocation",
"HttpCode": null,
"ErrorMessage": null,
"MchdNumber": "341c00d4-8a27-4166-83c2-d7e4b3bdbd36",
"MchdStatus": "AWAIT_SENDING_TO_CPRR",
"MchdStatusRus": "ОЖИДАНИЕ ПЕРЕДАЧИ ЗАПРОСА В СИСТЕМУ ХРАНЕНИЯ",
"ContentType": null,
"MchdFileId": null,
"IsDeleted": false }
{
"ResponseId": "4b10d531-ac8a-4139-a50d-34a32df5b7a0",
"RequestId": "3810804e-5452-448c-9b0e-539650e798fa",
"CreationDateTime": "2023-09-05 10:07:45.135923",
"RequestType": "Mchd",
"HttpCode": 400,
"ErrorMessage": "{\"type\":\"/errors/poa.issuer_signer_mismatch_with_egrul\",\"title\":\"Данные доверителя и подписанта в доверенности не соответствуют данным из ЕГРЮЛ\",\"status\":400,\"detail\":\"\",\"instance\":\"/api/v0/poar-webapp/integration/poa\",\"meta\":null}",
"MchdNumber": "8aa00a0b-dea6-42f9-a0c2-89b3269be1c5",
"MchdStatus": "SEND_TO_CPRR_ERROR",
"MchdStatusRus": "ОШИБКА ПРИЕМА ЗАПРОСА В СИСТЕМУ ХРАНЕНИЯ",
"ContentType": null,
"MchdFileId": null,
"IsDeleted": true }
{
"ResponseId": "6a86045b-450d-4e91-8556-6b331dae0f3c",
"RequestId": "6b3e566f-f850-4410-9220-e4dc03eb1d32",
"CreationDateTime": "2023-09-05 10:49:05.657741",
"RequestType": "GetStatus",
"HttpCode": 200,
"ErrorMessage": null,
"MchdNumber": "31ec16d8-2b52-4855-879b-b6a128972d62",
"MchdStatus": "PROCESSING",
"MchdStatusRus": "ОЖИДАНИЕ ПОДТВЕРЖДЕНИЯ",
"ContentType": null,
"MchdFileId": null,
"IsDeleted": false }
{
"ResponseId": "6a86045b-450d-4e91-8556-6b331dae0f3c",
"RequestId": "2477cdf9-6f79-42fc-ba16-c9721cf88a91",
"CreationDateTime": "2023-09-05 10:49:05.657741",
"RequestType": "GetMchd",
"HttpCode": 200,
"ErrorMessage": null,
"MchdNumber": "31ec16d8-2b52-4855-879b-b6a128972d62",
"MchdStatus": "PROCESSING",
"MchdStatusRus": "ОЖИДАНИЕ ПОДТВЕРЖДЕНИЯ",
"ContentType": null,
"MchdFileId": null,
"IsDeleted": false }
{
"ResponseId": "c878514d-0cf6-4882-a536-2eb2b384b81a",
"RequestId": "030f6e4c-94a5-403f-8132-2a69a27822ee",
"CreationDateTime": "2024-01-26 11:20:59.957509",
"RequestType": "GetMchd",
"SvedSyst": "CPRR",
"HttpCode": 200,
"ErrorMessage": null,
"MchdNumber": "e5d9cc1b-5386-4897-ad17-bde537562d02",
"MchdStatus": "READY_FOR_DOWNLOAD",
"MchdStatusRus": "ГОТОВА ДЛЯ СКАЧИВАНИЯ",
"ContentType": "application/zip",
"MchdFileId": "10eb821c-2ca3-4d2a-b5a2-9672254a50e2",
"IsDeleted": false }
Состав архива файлов МЧД
В возвращаемый архив файлов МЧД могут входить:
- Формат_МЧД_дата_номер (guid)_МЧД.xml - файл с содержимым МЧД
- Формат_МЧД_дата_номер (guid)_МЧД.sig - подпись МЧД
- Формат_МЧД_дата_номер (guid)_МЧД_lk_fts.sig - подпись МЧД для загрузки в ЛК ФТС
- Формат_МЧД_дата_номер (guid)_МЧД.vsl.pdf визуализация МЧД в pdf со штампиками подписания
- Формат_МЧД_дата_номер (guid)_МЧД.sig.pdf - МЧД в формате pdf со встроенной КЭП (при подписании МЧД в сервисе МЧД.МИГ24)
- Квит_Формат_МЧД_дата_номер (guid)_МЧД.xml - квитанция системы хранения о принятии МЧД
- Квит_Формат_МЧД_дата_номер (guid)_МЧД.sig - подпись квитанции системы хранения о принятии МЧД
- Квит_ЗаявОтм_СвДоверит__ИНН_КПП.xml - квитанция системы хранения о принятии заявления на отмену МЧД
- Квит_ЗаявОтм_СвДоверит_ИНН_КПП.sig - подпись квитанции системы хранения о принятии заявления на отмену МЧД
Методы работы со справочниками (полномочия)
Методы работы со справочниками (полномочия)
Методы предназначены для получения актуальной (или нужной) версии справочников полномочий, ограничений и значений для ограничений полномочий в соответствии с Единой системы нормативной справочной информации (ЕСНСИ) и других справочников полномочий для МЧД.
Получение кодов доступных справочников - /api/esnsi/codes
Коды справочников, доступные для получения:
POWER_B2B - Код справочника полномочий B2G (для формата ФНС)
POWER_B2G - Код справочника полномочий B2B (для формата 002)
POWER_PWR_CLASS - Код справочника полномочий (для единого формата (003))
POWER_PWR_RESR - Код справочника ограничений полномочий (для единого формата)
POWER_PWR_RESTR_VALUE - Код справочника значений для ограничений полномочий
POWER_SFR - Код справочника полномочий Социального Фонда России (СФР) (скоро).
Получение последней версии справочника -/api/esnsi/{code}/last-version
Получений доступных версий справочника -/api/esnsi/{code}/versions
Получение zip-архива со справочником ЕСНСИ в формате xml -/api/esnsi/data
Получение кодов доступных справочников - /api/esnsi/codes
Коды справочников, доступные для получения:
POWER_B2B - Код справочника полномочий B2G (для формата ФНС)
POWER_B2G - Код справочника полномочий B2B (для формата 002)
POWER_PWR_CLASS - Код справочника полномочий (для единого формата (003))
POWER_PWR_RESR - Код справочника ограничений полномочий (для единого формата)
POWER_PWR_RESTR_VALUE - Код справочника значений для ограничений полномочий
POWER_SFR - Код справочника полномочий Социального Фонда России (СФР) (скоро).
Получение последней версии справочника -/api/esnsi/{code}/last-version
Получений доступных версий справочника -/api/esnsi/{code}/versions
Получение zip-архива со справочником ЕСНСИ в формате xml -/api/esnsi/data
Создание/загрузка МЧД в сервисе, в том числе через json
Создание/загрузка МЧД в сервисе, в том числе через json
Создание пустой доверенности в формате B2G ФНС (5.01) - /api/b2g
Возвращается идентификатор mchdInfoId созданной МЧД.
!!! формат 5,02 не поддерживается для передачи через ЦПРР ФНС.
Создание пустой доверенности B2B (002) - /api/b2b
Возвращается идентификатор mchdInfoId созданной МЧД
Создание пустой доверенности в едином формате (003) - /api/em4d
Возвращается идентификатор mchdInfoId созданной МЧД
Создание МЧД через загрузку файлов xml и sig - /api/import?validate=true
validate - проверить xml по xsd-схеме. Пока нет поддержки проверки для единого формата, поэтому или не указывать validate или validate=false.
Допускается загрузка массива файлов неподписанных МЧД в формате xml.
При загрузке подписанной МЧД возможна загрузка только одного комплекта xml + sig, при этом происходит проверка на наличие в сервисе МЧД с таким же номером (guid).
Возвращается идентификатор mchdInfoId созданной МЧД
Создание МЧД через загрузку json - /api/import/json
Возвращается идентификатор mchdInfoId созданной МЧД. Для загрузки используется модель нужного типа МЧД (B2G, B2B, Единый, СФР).
Изменение (замена данных) существующей неподписанной МЧД - /api/import/json?mchdInfoId={mchdInfoId}
mchdInfoId - идентификатор МЧД в которой заменяются данные
модель аналогична той, что используется при создании МЧД через json.
Создание МЧД #ФТС через загрузку json - /api/import/json-for-fts
Возвращается идентификатор mchdInfoId созданной МЧД.
Общая схема запроса, Доверитель ЮЛ+ФЛ, Доверитель ИП+ФЛ
Помимо стандартных данных для МЧД, необходимы регистрационные данные ЭД2. Для получения регистрационных данных необходимо обратиться в техническую поддержку НТСсофт.
Возвращается идентификатор mchdInfoId созданной МЧД.
!!! формат 5,02 не поддерживается для передачи через ЦПРР ФНС.
Создание пустой доверенности B2B (002) - /api/b2b
Возвращается идентификатор mchdInfoId созданной МЧД
Создание пустой доверенности в едином формате (003) - /api/em4d
Возвращается идентификатор mchdInfoId созданной МЧД
Создание МЧД через загрузку файлов xml и sig - /api/import?validate=true
validate - проверить xml по xsd-схеме. Пока нет поддержки проверки для единого формата, поэтому или не указывать validate или validate=false.
Допускается загрузка массива файлов неподписанных МЧД в формате xml.
При загрузке подписанной МЧД возможна загрузка только одного комплекта xml + sig, при этом происходит проверка на наличие в сервисе МЧД с таким же номером (guid).
Возвращается идентификатор mchdInfoId созданной МЧД
Создание МЧД через загрузку json - /api/import/json
Возвращается идентификатор mchdInfoId созданной МЧД. Для загрузки используется модель нужного типа МЧД (B2G, B2B, Единый, СФР).
Изменение (замена данных) существующей неподписанной МЧД - /api/import/json?mchdInfoId={mchdInfoId}
mchdInfoId - идентификатор МЧД в которой заменяются данные
модель аналогична той, что используется при создании МЧД через json.
Создание МЧД #ФТС через загрузку json - /api/import/json-for-fts
Возвращается идентификатор mchdInfoId созданной МЧД.
Общая схема запроса, Доверитель ЮЛ+ФЛ, Доверитель ИП+ФЛ
Помимо стандартных данных для МЧД, необходимы регистрационные данные ЭД2. Для получения регистрационных данных необходимо обратиться в техническую поддержку НТСсофт.
Регистрационные данные для формирования XML МЧД ФТС
В параметрах запроса необходимо добавить:
participantId - Идентификатор декларанта
login - Транспортный логин
password - Транспортный пароль
sender - Адрес отправки
email - Почта для отправки уведомлений о смене статуса МЧД
participantId - Идентификатор декларанта
login - Транспортный логин
password - Транспортный пароль
sender - Адрес отправки
email - Почта для отправки уведомлений о смене статуса МЧД
Общая схема XML МЧД ФТС
{ "EMCHD":
{ "Osnov": { "Info":
{ "Nomer": "1384d40e-f486-44c5-a85b-ed6413443b67",
"DataNach": "04.06.2023", "DataOkon": "15.06.2023", },
"Doverit": {
"Podpisant": "Павлов Павел Павлович",
"UL" или "IP": {
... } },
"UpPred": { "FL": { ... } },
"Poln": { "KodPoln": [ { "Kod": "FTS_10001" }, { "Kod": "FTS_10002" } ] } } } }
{ "Osnov": { "Info":
{ "Nomer": "1384d40e-f486-44c5-a85b-ed6413443b67",
"DataNach": "04.06.2023", "DataOkon": "15.06.2023", },
"Doverit": {
"Podpisant": "Павлов Павел Павлович",
"UL" или "IP": {
... } },
"UpPred": { "FL": { ... } },
"Poln": { "KodPoln": [ { "Kod": "FTS_10001" }, { "Kod": "FTS_10002" } ] } } } }
Cхема XML МЧД ФТС Доверитель: Российская организация, Уполномоченный: ФЛ
{ "EMCHD": { "Osnov": { "Info": { "Nomer": "f134b054-f4c8-45ea-9334-82b0dfa3abf3", "DataNach": "14.12.2023", "DataOkon": "28.12.2023" }, "Doverit": { "Podpisant": "Андрей Андреевич Андреев", "UL": { "Naim": "ООО Доверитель", "INN": "5267897486", "KPP": "452044325", "OGRN": "3088044498726", "Region": "77", "AdrRF": "г. Москва, ул. Московская, стр.48, офис 108", "Ruk": { "FL": { "Dolzhnost": "Генеральный директор", "SNILS": "15533566268", "INN": "261672203744" } } } }, "UpPred": { "FL": { "FIO": "Евгеньева Евгения Евгеньевна", "INN": "107303231066", "SNILS": "42439477901", "DataRozhd": "18.07.1992", "UdLichn": { "KodVidDoc": "21", "SerNomDoc": "7456 985451", "DataDoc": "21.04.2008", "VydDoc": "ГУ МВД РОССИИ ПО СВЕРДЛОВСКОЙ ОБЛ.", "KodVydDoc": "660-001" } } }, "Poln": { "KodPoln": [ { "Kod": "FTS_10001" }, { "Kod": "FTS_10002" } ] } } } }
Cхема XML МЧД ФТС Доверитель: Индивидуальный предприниматель, Уполномоченный: ФЛ
{ "EMCHD": { "Osnov": { "Info": { "Nomer": "efb6b82d-b605-4cb1-88d6-4928ab0e3f35", "DataNach": "05.12.2023", "DataOkon": "28.12.2023" }, "Doverit": { "Podpisant": "Андрей Андреевич Андреев", "IP": { "OGRNIP": "313486519513822", "INN": "038110107423", "SNILS": "97419260949" } }, "UpPred": { "FL": { "FIO": "Евгеньева Евгения Евгеньевна", "INN": "107303231066", "SNILS": "42439477901", "DataRozhd": "18.07.1992", "UdLichn": { "KodVidDoc": "21", "SerNomDoc": "7456 985451", "DataDoc": "21.04.2008", "VydDoc": "ГУ МВД РОССИИ ПО СВЕРДЛОВСКОЙ ОБЛ.", "KodVydDoc": "660-001" } } }, "Poln": { "KodPoln": [ { "Kod": "FTS_10001" }, { "Kod": "FTS_10002" } ] } } } }
Подписание МЧД / отмена МЧД
Подписание МЧД / отмена МЧД
Подписание МЧД, размещенной в сервисе можно произвести следующими способами:
Загрузка подписи sig для неподписанной доверенности - /api/import?mchdInfoId={mchdInfoId}&idFileDate={idFileDate}
mchdInfoId - идентификатор МЧД в сервисе
idFileDate - дата реального подписания xml МЧД на стороне пользователя. Указывается, если отличается от текущей даты.
Важно: при приеме sig в этом методе сервис сформирует xml из актуальных данных этой МЧД на указанную дату и произведет проверку соответствия подписанных данных и данных в сервисе.
Подписание МЧД, размещенной в реестре сервиса - /api/signature/
Процесс подписание одинаков для всех типов МЧД сервиса, включая СФР.
Шаг 1 - Предоставление сертификата КЭП подписанта, запрос хеша xml МЧД для подписания /api/signature/step1 пример
Шаг 2 - Подписание полученного хеша xml МЧД на стороне внешней ИС, отправка подписанного хеша xml МЧД, получение хеша pdf (электронная МЧД) для подписания /api/signature/step2 пример
Шаг 3 - Подписание полученного хеша pdf МЧД на стороне внешней ИС, отправка подписанного хеша pdf МЧД, завершение подписания - /api/signature/step3 пример
Создание ссылки на подписание МЧД на web форме сервиса
Ссылка имеет вид https://m4d.mig24.online/m4d/ + идентификатор МЧД - mchdInfoId
Создание ссылки на подписание Доверителем - /api/signature/url/{mchdInfoId}
Возвращается ссылка вида: https://mig24.online/registry/files/2e150be5-644e-48ed-a7b2-b06608bd92ce
Отправить МЧД на подписание в мобильное приложение МИГ24 - Скоро
Удалить подпись у МЧД - /api/signature/delete
Удаление пока возможно только в статусе "Ошибка при отправке на хранение"
После успешного выполнения в сервисе удаляются файлы подписи и МЧД переходит в статус " На подписании"
- выгрузить xml, подписать своими средствами, подгрузить обратно в сервис полученную Квалифицированную электронную подпись (der/base64) (CAdES-BES, Cades-T (с меткой времени TSP), CAdES-X Long Type 1 (c метками TSP и OCSP))
- подписать МЧД, размещенной в сервисе средствами сервиса
- предоставить возможность подписания МЧД на web-форме сервиса
- предоставить возможность подписания по ссылке Доверителя
- предоставить возможность подписания в мобильном приложении МИГ24
Получить xml-файл доверенности - /api/m4d/{mchdInfoId}/xml
Возвращается xml-файл МЧДЗагрузка подписи sig для неподписанной доверенности - /api/import?mchdInfoId={mchdInfoId}&idFileDate={idFileDate}
mchdInfoId - идентификатор МЧД в сервисе
idFileDate - дата реального подписания xml МЧД на стороне пользователя. Указывается, если отличается от текущей даты.
Важно: при приеме sig в этом методе сервис сформирует xml из актуальных данных этой МЧД на указанную дату и произведет проверку соответствия подписанных данных и данных в сервисе.
Подписание МЧД, размещенной в реестре сервиса - /api/signature/
Процесс подписание одинаков для всех типов МЧД сервиса, включая СФР.
Шаг 1 - Предоставление сертификата КЭП подписанта, запрос хеша xml МЧД для подписания /api/signature/step1 пример
Шаг 2 - Подписание полученного хеша xml МЧД на стороне внешней ИС, отправка подписанного хеша xml МЧД, получение хеша pdf (электронная МЧД) для подписания /api/signature/step2 пример
Шаг 3 - Подписание полученного хеша pdf МЧД на стороне внешней ИС, отправка подписанного хеша pdf МЧД, завершение подписания - /api/signature/step3 пример
Создание ссылки на подписание МЧД на web форме сервиса
Ссылка имеет вид https://m4d.mig24.online/m4d/ + идентификатор МЧД - mchdInfoId
Создание ссылки на подписание Доверителем - /api/signature/url/{mchdInfoId}
Возвращается ссылка вида: https://mig24.online/registry/files/2e150be5-644e-48ed-a7b2-b06608bd92ce
Отправить МЧД на подписание в мобильное приложение МИГ24 - Скоро
Удалить подпись у МЧД - /api/signature/delete
Удаление пока возможно только в статусе "Ошибка при отправке на хранение"
После успешного выполнения в сервисе удаляются файлы подписи и МЧД переходит в статус " На подписании"
Пример шаг 1
{
"Token":"731f4f45-321b-42f0-8dc8-33816271e0ab", "Certificate":"MIIIRzCCB/SgAwIBAgIQAdf8qVQkWeAAAAA...",
"MchdInfoId":"89179c3f-7336-4dff-852a-98188d1de5a5" }
Результат: 200 OK
{
"Token":"017af5c8-f9f3-4b7d-ad9c-a831213d4fe4",
"Files":[ {
"FileId":"a25dbf23-e8ce-4fd4-857d-6bbadedaadc1", "Base64":"jv6lRHCdZmoG6ZwojyJPatVxhX9J9DkoXEYrgNe4VBw=", "Hex":"8EFEA544709D666A06E99C288F224F6AD571857F49F439285C462B80D7B8541C"}] }
"Token":"731f4f45-321b-42f0-8dc8-33816271e0ab", "Certificate":"MIIIRzCCB/SgAwIBAgIQAdf8qVQkWeAAAAA...",
"MchdInfoId":"89179c3f-7336-4dff-852a-98188d1de5a5" }
Результат: 200 OK
{
"Token":"017af5c8-f9f3-4b7d-ad9c-a831213d4fe4",
"Files":[ {
"FileId":"a25dbf23-e8ce-4fd4-857d-6bbadedaadc1", "Base64":"jv6lRHCdZmoG6ZwojyJPatVxhX9J9DkoXEYrgNe4VBw=", "Hex":"8EFEA544709D666A06E99C288F224F6AD571857F49F439285C462B80D7B8541C"}] }
Пример шаг 2
{
"Token":"831f4f55-381b-42f0-8dc8-32816271e0ab",
"Files":[ {FileId":"a25dbf23-e8ce-4fd4-857d-6bbadedaadc1", "Signature":"R/5KXNbo8drl02lYXP2CGALSpLWHzMOxNLCY+O4JUXd9u7hGSYTq1P9hz/mCLb8zO
ofiduM3f8Ee4ddoZVpGNA=="} ]}
Результат: 200 OK {
"Token":"e6318301-c6d5-42cc-9d19-e0c6f666015c",
"Files":[ {"FileId":"09fa7064-7c3d-47c6-9626-d07899cbf7be", "Base64":"BiDFbmrvWCHxriY89oXhrAzHEjW+kPabQ7ArUzq+JvY=", "Hex":"0620C56E6AEF5821F1AE263CF685E1AC0CC71235BE90F
69B43B02B533ABE26F6" } ]}
"Token":"831f4f55-381b-42f0-8dc8-32816271e0ab",
"Files":[ {FileId":"a25dbf23-e8ce-4fd4-857d-6bbadedaadc1", "Signature":"R/5KXNbo8drl02lYXP2CGALSpLWHzMOxNLCY+O4JUXd9u7hGSYTq1P9hz/mCLb8zO
ofiduM3f8Ee4ddoZVpGNA=="} ]}
Результат: 200 OK {
"Token":"e6318301-c6d5-42cc-9d19-e0c6f666015c",
"Files":[ {"FileId":"09fa7064-7c3d-47c6-9626-d07899cbf7be", "Base64":"BiDFbmrvWCHxriY89oXhrAzHEjW+kPabQ7ArUzq+JvY=", "Hex":"0620C56E6AEF5821F1AE263CF685E1AC0CC71235BE90F
69B43B02B533ABE26F6" } ]}
Пример шаг 3
{
"Token":"741f4f55-381b-42f0-8dc8-32816271e0ab",
"Files":[ {"FileId":"08fa7064-7c3d-47c6-9626-d07899cbf7be", "Signature":"Bb5hKc5iyg8CqyoOhpy1Khq/ZCC4n1VQuK
RnexXUpNOTzSug2v00KdEzgtOICRAcFfeziuJMt/YFH4IN1zLV7A=="} ]}
Результат: 200 OK
Возвращается идентификатор mchdInfoId на подписанную МЧД.
"Token":"741f4f55-381b-42f0-8dc8-32816271e0ab",
"Files":[ {"FileId":"08fa7064-7c3d-47c6-9626-d07899cbf7be", "Signature":"Bb5hKc5iyg8CqyoOhpy1Khq/ZCC4n1VQuK
RnexXUpNOTzSug2v00KdEzgtOICRAcFfeziuJMt/YFH4IN1zLV7A=="} ]}
Результат: 200 OK
Возвращается идентификатор mchdInfoId на подписанную МЧД.
Пример подписания хеша
Такую подпись хеш мы ожидаем на входе
https://docs.cryptopro.ru/cades/reference/cadescom/cadescom_class/rawsignature
пример с плагином
https://cpdn.cryptopro.ru/content/cades/plugin-samples-raw-signature.html
https://docs.cryptopro.ru/cades/reference/cadescom/cadescom_class/rawsignature
пример с плагином
https://cpdn.cryptopro.ru/content/cades/plugin-samples-raw-signature.html
Отмена (отзыв) МЧД
Отмена (отзыв) МЧД
Подписание заявления на отмену МЧД, размещенной в сервисе, можно произвести следующими способами:
Шаг 2 - Подписание хеш отзыва xml МЧД и отправка подписанного хеша отзыва xml МЧД - api/revocate/signature/step2пример
Отправить подписанное заявление на отмену МЧД - /api/fns/revoke/{mchdInfoId}?email={email}
email - Email для получения уведомления о результатах отмены.
Получить zip-архив с xml отмены МЧД и файла подписи - /api/revocate/{mchdInfoId}/archive
Возвращается файл
- выгрузить xml заявления на отмену, подписать своими средствами, подгрузить обратно в сервис полученную КЭП.
- подписать xml заявления на отмену средствами сервиса
- Скоро: получить ссылку на подписание заявление или отправить в мобильное приложение.
Сформировать и получить xml-файл отзыва подписанной доверенности -/api/revocate/{mchdInfoId}/xml
Для формирования xml необходимо предоставление дополнительных данных. пример
Загрузить подпись sig для отмены МЧД - /api/revocate/sig
mchdInfoId - идентификатор МЧД в сервисе
Подпись отмены (отзыва) МЧД:
Шаг 1 - Передача сертификата КЭП подписанта и данных для отмены, получение хеша xml файла отмены МЧД для подписания - /api/revocate/signature/step1 примерШаг 2 - Подписание хеш отзыва xml МЧД и отправка подписанного хеша отзыва xml МЧД - api/revocate/signature/step2пример
Отправить подписанное заявление на отмену МЧД - /api/fns/revoke/{mchdInfoId}?email={email}
email - Email для получения уведомления о результатах отмены.
Получить zip-архив с xml отмены МЧД и файла подписи - /api/revocate/{mchdInfoId}/archive
Возвращается файл
Данные для формирования XML отмены МЧД
В запросе необходимо добавить DataObj:
DataOtz - Дата отзыва
PrichOtz - Причина отзыва
SvDoveritSelector - NPUL - юридическое лицо, NPIP - индивидуальный предприниматель, NPFL физическое лицо, IO - иностранная организация
NpulSvFLDolzhnost - Должность для юридического лица
NpflDataRozhd - Дата рождения для физического лица
PodpisantTel - Телефон подписанта
Пример:
{
"DataOtz": "20.04.2023",
"PrichOtz": "Причина отзыва",
"SvDoveritSelector": "NPUL",
"NpulSvFLDolzhnost": "Менеджер",
"NpflDataRozhd": "",
"PodpisantTel": "456-78-999" }
DataOtz - Дата отзыва
PrichOtz - Причина отзыва
SvDoveritSelector - NPUL - юридическое лицо, NPIP - индивидуальный предприниматель, NPFL физическое лицо, IO - иностранная организация
NpulSvFLDolzhnost - Должность для юридического лица
NpflDataRozhd - Дата рождения для физического лица
PodpisantTel - Телефон подписанта
Пример:
{
"DataOtz": "20.04.2023",
"PrichOtz": "Причина отзыва",
"SvDoveritSelector": "NPUL",
"NpulSvFLDolzhnost": "Менеджер",
"NpflDataRozhd": "",
"PodpisantTel": "456-78-999" }
Подписание XML отмены МЧД
"Token":"731f4f55-381b-42f0-8dc8-32816271e0ab",
"Certificate":"MIIIRzCCB/SgAwIBAgIQAdf8qVQkWeAAAAA...",
"MchdInfoId":"89179c3f-7336-4dff-852a-98188d1de5a5",
"DataObj": { "DataOtz": "20.04.2023", "PrichOtz": "Причина отзыва", "SvDoveritSelector": "NPUL", "NpulSvFLDolzhnost": "Менеджер", "NpflDataRozhd": "", "PodpisantTel": "456-78-999" }
Результат: 200 OK
{ "Token":"015af5c8-f9f3-4b7d-ad9c-a821213d4fe4",
"Files":[ {"FileId":"a25dbf23-e8ce-4fd4-857d-6bbadedaadc1",
"Base64":"jv6lRHCdZmoG6ZwojyJPatVxhX9J9DkoXEYrgNe4VBw=",
"Hex":"8EFEA544709D666A06E99C288F224F6AD571857F49F439285C462B80D7B8541C"}] }
"Certificate":"MIIIRzCCB/SgAwIBAgIQAdf8qVQkWeAAAAA...",
"MchdInfoId":"89179c3f-7336-4dff-852a-98188d1de5a5",
"DataObj": { "DataOtz": "20.04.2023", "PrichOtz": "Причина отзыва", "SvDoveritSelector": "NPUL", "NpulSvFLDolzhnost": "Менеджер", "NpflDataRozhd": "", "PodpisantTel": "456-78-999" }
Результат: 200 OK
{ "Token":"015af5c8-f9f3-4b7d-ad9c-a821213d4fe4",
"Files":[ {"FileId":"a25dbf23-e8ce-4fd4-857d-6bbadedaadc1",
"Base64":"jv6lRHCdZmoG6ZwojyJPatVxhX9J9DkoXEYrgNe4VBw=",
"Hex":"8EFEA544709D666A06E99C288F224F6AD571857F49F439285C462B80D7B8541C"}] }
Подписание XML отмены МЧД
{
"Token":"731f4f55-381b-42f0-8dc8-32816271e0ab",
"Files":[ {
FileId":"a25dbf23-e8ce-4fd4-857d-6bbadedaadc1",
"Signature":"R/5KXNbo8drl02lYXP2CGALSpLWHzMOxNLCY+O4JUXd9u7hGSYTq1P9hz/mCLb8zO
ofiduM3f8Ee4ddoZVpGNA=="} ]}
Результат: 200 OK
"89179c3f-7336-4dff-852a-98188d1de5a5"
"Token":"731f4f55-381b-42f0-8dc8-32816271e0ab",
"Files":[ {
FileId":"a25dbf23-e8ce-4fd4-857d-6bbadedaadc1",
"Signature":"R/5KXNbo8drl02lYXP2CGALSpLWHzMOxNLCY+O4JUXd9u7hGSYTq1P9hz/mCLb8zO
ofiduM3f8Ee4ddoZVpGNA=="} ]}
Результат: 200 OK
"89179c3f-7336-4dff-852a-98188d1de5a5"
Работа с реестром МЧД сервиса
Работа с реестром МЧД сервиса
Получить список всех МЧД для пользователя - /api/mchd-infos?userId=
userId - необязательны Id пользователя, создавшего МЧД. Если userId пустой, то используется ID пользователя из авторизации
Получить список всех подписанных МЧД по СНИЛС уполномоченного лица - /api/signed/{snils}
Возвращается массив данных - метод требует отдельного разрешения для использования
Получить список всех МЧД по ОГРН (ОГРНИП) доверителя - /api/mchd-infos/ogrn/{ogrn}
Возвращается массив данных - метод требует отдельного разрешения для использованияРабота существующей МЧД
Работа существующей МЧД
Копировать МЧД - /api/m4d/{mchdInfoId}/copy
Возвращается идентификатор mchdInfoId на новую (копию) МЧД
Удалить МЧД в сервисе- /api/m4d/{mchdInfoId}
МЧД помечается как удаленная и не показывается при просмотре. Удаление подписанной МЧД не допускается.
Проверить МЧД на правильность заполненности - /api/m4d/{mchdInfoId}/validate
Если проверка пройдена успешно, то "IsValid": true, если не успешно, то "IsValid": false
и возвращается список ошибок (json).
Сменить форму редактирования МЧД - /api/m4d/{mchdInfoId}/form-kind/{formKind}
Вид формы для единого формата: FNS, FTS
Форма редактирования влияет только на внешний вид web-формы.
Применимо только "своих" для МЧД, созданных через API.
Установить факт оплаты МЧД - /api/m4d/{mchdInfoId}/paid
Метод нужен для возможности подписания доверенности через web, не через API.
Применимо только "своих" для МЧД, созданных через API.
Возможность использования данного метода регулируется договором (платно)
Получить статус оплаты МЧД - /api/m4d/{mchdInfoId}/is-paid
Возвращает набор параметров
"IsPaid" - признак, оплачена ли МЧД
"Member" - информация, кто произвел оплату (ОГРН/СНИЛС,UserID)
"Method": метод, которым произведена оплата.
"PayInfoId": идентификатор записи об оплате
Обновить (изменить) тип системы хранения существующей МЧД - /api/m4d/update-storage-type
Изменение места хранения МЧД:
- Fns - ЦПРР ФНС
- Mig24 - МЧД.МИГ24
Изменение возможно только для неподписанной МЧД.
Получить информацию о файлах МЧД - /api/m4d/{mchdInfoId}/files-info
Возвращает список файлов, сформированных по данной МЧД (xml, sig, pdf)
Получить zip-архив файлов МЧД - /api/m4d/{mchdInfoId}/archive
Возвращается zip-архив файлов МЧДПолучить xml-файл МЧД - /api/m4d/{mchdInfoId}/xml
Возвращается xml-файл МЧДПолучить pdf-файл МЧД - /api/m4d/{mchdInfoId}/pdf
Возвращается pdf-файл МЧД
Отправить в ФТС запрос на регистрацию МЧД - /api/send-link-poa/{mchdInfoId}
Зарегистрировать в ФТС можно только МЧД с кодовыми полномочиями для ФТС.
Получить сокращенные мета-данные по МЧД - /api/mchd-infos/{mchdInfoId}/short
Возвращается номер МЧД, ИНН доверителя, ИНН,СНИЛС уполномоченного, статус МЧД. - метод требует отдельного разрешения для использован
Пример ошибок проверки валидности МЧД
{
"IsValid": false,
"Messages": [ {
"JsonId": "EMCHD.Osnov.Info.DataOkon",
"Name": "Дата окончания действия доверенности",
"Message": "Обязательное поле",
"ItemType": "Error" },
{
"JsonId": "EMCHD.Osnov.Doverit.UL.Ruk.FL.SNILS",
"Name": "СНИЛС",
"Message": "Обязательное поле",
"ItemType": "Error" },
{
"JsonId": "EMCHD.Osnov.UpPred.FL.UdLichn.KodVydDoc",
"Name": "Код подразделения",
"Message": "Обязательное поле, если код документа не \"10 - Паспорт иностранного гражданина\"",
"ItemType": "Error" } ] }
Другие ошибки:
"IsValid": false,
"Messages": [ {
"JsonId": "EMCHD.Osnov.Info.DataOkon",
"Name": "Дата окончания действия доверенности",
"Message": "Обязательное поле",
"ItemType": "Error" },
{
"JsonId": "EMCHD.Osnov.Doverit.UL.Ruk.FL.SNILS",
"Name": "СНИЛС",
"Message": "Обязательное поле",
"ItemType": "Error" },
{
"JsonId": "EMCHD.Osnov.UpPred.FL.UdLichn.KodVydDoc",
"Name": "Код подразделения",
"Message": "Обязательное поле, если код документа не \"10 - Паспорт иностранного гражданина\"",
"ItemType": "Error" } ] }
Другие ошибки:
- 404 NotFound Доверенность не найдена
- 400 BadRequest Проверка для данного формата пока не реализована
- 400 BadRequest Проверка передоверия единого формата пока не реализована
Пример информации о файлах МЧД
[ {
"ContentType": "application/xml",
"Name": "ON_DOVEL_0256_0256_1234567894151515151_20221117_6ab78dc0-45b1-4fad-8dd1-
d65a34f81bde.xml",
"CreationDateTime": "2022-11-17T14:00:57.519256" },
{
"ContentType": "application/octet-stream",
"Name": "ON_DOVEL_0256_0256_1234567894151515151_20221117_6ab78dc0-45b1-4fad-8dd1-
d65a34f81bde.xml.sig",
"CreationDateTime": "2022-11-17T14:00:57.519256" },
{
"ContentType": "application/pdf",
"Name": "ON_DOVEL_0256_0256_1234567894151515151_20221117_6ab78dc0-45b1-4fad-8dd1-
d65a34f81bde.pdf",
"CreationDateTime": "2022-11-17T14:00:57.519256" } ]
"ContentType": "application/xml",
"Name": "ON_DOVEL_0256_0256_1234567894151515151_20221117_6ab78dc0-45b1-4fad-8dd1-
d65a34f81bde.xml",
"CreationDateTime": "2022-11-17T14:00:57.519256" },
{
"ContentType": "application/octet-stream",
"Name": "ON_DOVEL_0256_0256_1234567894151515151_20221117_6ab78dc0-45b1-4fad-8dd1-
d65a34f81bde.xml.sig",
"CreationDateTime": "2022-11-17T14:00:57.519256" },
{
"ContentType": "application/pdf",
"Name": "ON_DOVEL_0256_0256_1234567894151515151_20221117_6ab78dc0-45b1-4fad-8dd1-
d65a34f81bde.pdf",
"CreationDateTime": "2022-11-17T14:00:57.519256" } ]
Взаимодействие с ЦПРР ФНС
Взаимодействие с ЦПРР ФНС
Отправить МЧД в ЦПРР ФНС /api/fns/send/{mchdInfoId}?validate=true
validate - с проверкой xml по xsd-схеме
Отправить подписанное заявление на отмену МЧД - /api/fns/revoke/{mchdInfoId}?email={email}
email - Email для получения уведомления о результатах отмены.
Получить информацию о статусе и сроке действия МЧД в ЦПРР ФНС - /api/fns/check/{mchdNumber}/info
Если необходимо для номера использовать символы типа "/", то используется метод - /api/fns/check/info?number={mchdNumber}
Сначала производится поиск доверенности в ЦПРР и возвращается статус из ЦПРР.Если ЦПРР не доступен, то будет ошибка "Ошибка сервера ФНС".
Если в ЦПРР доверенность не найдена, то производится поиск в сервисе МЧД24 и возвращается статус из МЧД24.
Если в ЦПРР и МЧД24 доверенность не найдена, то возвращается ошибка "Доверенность не найдена в ЦПРР ФНС и отсутствует в сервисе МЧД24".
Получить файл архива МЧД из ЦПРР ФНС - /api/fns/download/{mchdNumber}/{issuerInn}
Необходимо указать номер МЧД и ИНН Доверителя
Возвращается zip-архив доверенности.
В случае отсутствия этой МЧД на узле МИГ24 вначале будет возвращаться строка "Статус: ОПЕРАЦИЯ ВЫПОЛНЯЕТСЯ. Идет запрос данных с узла ФНС. Попробуйте скачать позднее." Ориентировочное время получения МЧД с других узлов - до 60 сек.
Пример архива с файлами МЧД
Получить информацию о полномочиях и статусе МЧД из ЦПРР ФНС
/api/fns/check-powers/{mchdNumber}/{issuerInn}Возвращается массив сведений.
В случае отсутствия этой МЧД на узле МИГ24 вначале будет возвращаться строка "Статус: ОПЕРАЦИЯ ВЫПОЛНЯЕТСЯ. Идет запрос данных с узла ФНС. Попробуйте скачать позднее." Ориентировочное время получения МЧД с других узлов - до 60 сек.
Получить статус доверенности из ЦПРР ФНС и обновить его в списке МЧД
/api/fns/sync/{mchdInfoId}Необходим для быстрой ручной актуализации статуса МЧД в МИГ24 из ЦПРР ФНС.
Статусы МЧД в ЦПРР ФНС
ОЖИДАНИЕ ПОДТВЕРЖДЕНИЯ - PROCESSING
ОТКАЗ В РЕГИСТРАЦИИ - REJECTED
ЗАРЕГИСТРИРОВАНА - CREATED
АКТИВНА - ACTIVE
ОТМЕНЕНА - REVOKED
ДЕЙСТВИЕ ИСТЕКЛО - EXPIRED
Статусы МЧД в МИГ24
Не подписана - Unsigned
Подписание не завершено - Draft
На подписании - OnRemoteSigning
Подписана - Signed
Отправлена в ЦПРР ФНС - FnsMchdSent
Ошибка при отправке в ЦПРР ФНС - FnsMchdSentError
Загружена в ЦПРР ФНС - FnsMchdLoaded
Ожидание отзыва - FnsRevocationSent
Ошибка отзыва - FnsRevocationSentError
Удалена - Deleted
Пример ответа о полномочиях МЧД
{
"MchdNumber": "14ec653c-96c2-4331-8cae-4a37878a2ed3",
"StatusRus": "АКТИВНА",
"StatusEng": "ACTIVE",
"StatusDate": "07.04.2023",
"DateFrom": "07.04.2023",
"DateTo": "30.04.2024",
"Powers": [ "02 - Представление отчетности", "03 - Получение документов в налоговом органе", "17 - Подписывать заявление на зачет/возврат налога", "21 - Подписывать документы (информацию)", "22 - Представлять документы (информацию)" ] }
Проведение проверок использования МЧД
Проведение проверок использования МЧД
Проверить МЧД на правильность заполненности - /api/m4d/{mchdInfoId}/validate
Если проверка пройдена успешно, то "IsValid": true, если не успешно, то "IsValid": false
и возвращается список ошибок (json).
Если проверка пройдена успешно, то "IsValid": true, если не успешно, то "IsValid": false
и возвращается список ошибок (json).