Принципы взаимодействия с api: различия между версиями
Перейти к навигации
Перейти к поиску
Shihov (обсуждение | вклад) м Shihov переименовал страницу Асп.маркировка:7 api:1 api гис мт v18.1:1 общие положения:1.1 принципы взаимодействия с api:начало в Принципы взаимодействия с api |
Shihov (обсуждение | вклад) Нет описания правки |
||
| Строка 2: | Строка 2: | ||
Взаимодействие участников оборота товара (далее – УОТ) и оператора Государственной информационной системы мониторинга за оборотом товаров (далее – ГИС МТ) осуществляется в электронном виде. Обмен документами на бумажном носителе не предусмотрен. | Взаимодействие участников оборота товара (далее – УОТ) и оператора Государственной информационной системы мониторинга за оборотом товаров (далее – ГИС МТ) осуществляется в электронном виде. Обмен документами на бумажном носителе не предусмотрен. | ||
=== Варианты электронного взаимодействия === | |||
Электронное взаимодействие осуществляется по одному из двух вариантов: | Электронное взаимодействие осуществляется по одному из двух вариантов: | ||
Электронное взаимодействие осуществляется путем обмена электронными документами в соответствии с определенным порядком | # '''Предоставление сведений''' - обмен электронными документами, на основании которых могут вноситься сведения в реестры ГИС МТ. Представление сведений определено как обязанность УОТ. | ||
подпись (УКЭП) | # '''Запрос сведений''' - обмен, при котором сведения из реестров ГИС МТ предоставляются УОТ в соответствии с установленными разрешениями на получение сведений. При этом изменения в реестры не вносятся. Запрос и последующее представление сведений из ГИС МТ инициируется УОТ по своему усмотрению и применяется, например, для проверки статусов КМ или статуса регистрации УОТ. | ||
=== Порядок взаимодействия === | |||
Электронное взаимодействие осуществляется путем обмена электронными документами в соответствии с определенным порядком: | |||
* Для юридически значимых электронных документов применяется **усиленная квалифицированная электронная подпись (УКЭП)** | |||
* УКЭП передается вместе с электронным документом | |||
* Электронное взаимодействие осуществляется с применением программных интерфейсов взаимодействия (API) ГИС МТ и информационных систем участников оборота товара | |||
=== Требования к взаимодействию через API === | |||
При взаимодействии через API выполняются следующие требования: | При взаимодействии через API выполняются следующие требования: | ||
# Аутентификация и авторизация УОТ (определение полномочий на осуществление электронного взаимодействия) осуществляется при помощи УКЭП | |||
# При предоставлении и запросе сведений защита передаваемых данных выполняется TLS/HTTPS (ГОСТ 28147-89) шифрованием канала передачи данных в адрес Оператора сертифицированными РФ СКЗИ (ГОСТ Р 34.10-2012) | |||
# В API отсутствует разделение на категории участников оборота товара | |||
=== Информация о вложенности параметров === | |||
Параметр считается вложенным, если выровнен не по левому краю таблицы. | Параметр считается вложенным, если выровнен не по левому краю таблицы. | ||
Пример вложенности: | '''Пример вложенности:''' | ||
[[File:1_вложенность.png]] | [[File:1_вложенность.png]] | ||
Читать как | '''Читать как:''' Параметр `results` содержит параметры `agentInn` и `children`, а `children` содержит параметр `brand`. | ||
=== Стенды === | |||
# [http://ismp.crpt.ru Базовый адрес промышленного ГИС МТ] | |||
# [http://demo.lp.crpt.tech Базовый адрес демонстрационной версии ГИС МТ] | |||
=== Обработка ошибок === | |||
Информация об ошибках при запросах API методов имеет следующий формат (подробнее см. "Справочник 'Статусы ответов'"): | |||
(подробнее | |||
'''Пример ошибки:''' | '''Пример ошибки:''' | ||
<syntaxhighlight lang='json'> | |||
<syntaxhighlight lang=' | |||
// Status code: 403 | // Status code: 403 | ||
Content-Type: application/json | Content-Type: application/json | ||
body: | body: | ||
{ | { | ||
"error_message": "Отсутствует доступ к ресурсу" | |||
} | } | ||
// Status code: 401 | // Status code: 401 | ||
// информация об ошибке возвращается в формате xml | // информация об ошибке возвращается в формате xml | ||
// Методы Национального каталога возвращают сообщения об ошибках, которые | // Методы Национального каталога возвращают сообщения об ошибках, | ||
могут быть как в xml, так и в json форматах в зависимости от выбранного | // которые могут быть как в xml, так и в json форматах в зависимости | ||
формата запроса | // от выбранного формата запроса | ||
</syntaxhighlight> | |||
=== Дополнительная информация === | |||
Коды стран представлены в соответствии с [https://www.iso.org/ru/iso-3166-country-codes.html ISO 3166]. | |||
[[Category:1.1 принципы взаимодействия с api]] | [[Category:1.1 принципы взаимодействия с api]] | ||
<vote type=1 /> | <vote type=1 /> | ||
Текущая версия от 13:17, 14 октября 2025
Принципы взаимодействия с API
Взаимодействие участников оборота товара (далее – УОТ) и оператора Государственной информационной системы мониторинга за оборотом товаров (далее – ГИС МТ) осуществляется в электронном виде. Обмен документами на бумажном носителе не предусмотрен.
Варианты электронного взаимодействия
Электронное взаимодействие осуществляется по одному из двух вариантов:
- Предоставление сведений - обмен электронными документами, на основании которых могут вноситься сведения в реестры ГИС МТ. Представление сведений определено как обязанность УОТ.
- Запрос сведений - обмен, при котором сведения из реестров ГИС МТ предоставляются УОТ в соответствии с установленными разрешениями на получение сведений. При этом изменения в реестры не вносятся. Запрос и последующее представление сведений из ГИС МТ инициируется УОТ по своему усмотрению и применяется, например, для проверки статусов КМ или статуса регистрации УОТ.
Порядок взаимодействия
Электронное взаимодействие осуществляется путем обмена электронными документами в соответствии с определенным порядком:
- Для юридически значимых электронных документов применяется **усиленная квалифицированная электронная подпись (УКЭП)**
- УКЭП передается вместе с электронным документом
- Электронное взаимодействие осуществляется с применением программных интерфейсов взаимодействия (API) ГИС МТ и информационных систем участников оборота товара
Требования к взаимодействию через API
При взаимодействии через API выполняются следующие требования:
- Аутентификация и авторизация УОТ (определение полномочий на осуществление электронного взаимодействия) осуществляется при помощи УКЭП
- При предоставлении и запросе сведений защита передаваемых данных выполняется TLS/HTTPS (ГОСТ 28147-89) шифрованием канала передачи данных в адрес Оператора сертифицированными РФ СКЗИ (ГОСТ Р 34.10-2012)
- В API отсутствует разделение на категории участников оборота товара
Информация о вложенности параметров
Параметр считается вложенным, если выровнен не по левому краю таблицы.
Пример вложенности:
Читать как: Параметр `results` содержит параметры `agentInn` и `children`, а `children` содержит параметр `brand`.
Стенды
Обработка ошибок
Информация об ошибках при запросах API методов имеет следующий формат (подробнее см. "Справочник 'Статусы ответов'"):
Пример ошибки:
// Status code: 403
Content-Type: application/json
body:
{
"error_message": "Отсутствует доступ к ресурсу"
}
// Status code: 401
// информация об ошибке возвращается в формате xml
// Методы Национального каталога возвращают сообщения об ошибках,
// которые могут быть как в xml, так и в json форматах в зависимости
// от выбранного формата запроса
Дополнительная информация
Коды стран представлены в соответствии с ISO 3166.
