Marketplace:Services:v1.0: различия между версиями

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Следующая правка →
ВизуальныйВики-текст
Создание страницы - Marketplace.Services.v1.0.wiki
 
Нет описания правки
Строка 3: Строка 3:
==Общие сведения==
==Общие сведения==


Профиль Marketplace.Services v1.0 — интеграционный профиль ВетИС.API для информационных систем операторов посреднических цифровых платформ (маркетплейсов).  
Профиль <code>Marketplace.Services v1.0</code> — интеграционный профиль ВетИС.API для информационных систем операторов посреднических цифровых платформ (маркетплейсов).  


Позволяет маркетплейсу получать из ФГИС «ВетИС» сведения, необходимые для проверки регистрации продавца, зарегистрированной номенклатуры товара и ветеринарного сопроводительного документа (ВСД).
Позволяет маркетплейсу получать из ФГИС «ВетИС» сведения, необходимые для проверки регистрации продавца, зарегистрированной номенклатуры товара и ветеринарного сопроводительного документа (ВСД).
Строка 13: Строка 13:
*v1.0 — Marketplace:Services:v1.0 (в разработке)
*v1.0 — Marketplace:Services:v1.0 (в разработке)


==Предоставляемые сервисы==
==Предоставляемые сервисы ==


{| class="wikitable"
{| class="wikitable"
Строка 23: Строка 23:
|}
|}


==Структура XSD==
==Структура XSD ==


Полные URI пространств имён указаны в самих XSD-схемах (передаются в составе пакета WSDL); в таблицах ниже приведены префиксы пространств.
Полные URI пространств имён указаны в самих XSD-схемах (передаются в составе пакета WSDL); в таблицах ниже приведены префиксы пространств.
Строка 32: Строка 32:
!XSD-схема!!Пространство имён
!XSD-схема!!Пространство имён
|-
|-
|application_v2.1.xsd
|
application_v2.1.xsd
|xmlns:<b>apl</b>
|xmlns:<b>apl</b>
|-
|-
Строка 54: Строка 55:


{| class="wikitable"
{| class="wikitable"
!XSD-схема!!Пространство имён
!XSD-схема!!
Пространство имён
|-
|-
|dictionary_v2.6.xsd
|dictionary_v2.6.xsd
Строка 118: Строка 120:
|}
|}


WSDL <code>ams-marketplace.service.wsdl</code> включает импорт штатного <code>ApplicationManagementService_v2.1.wsdl</code> и <code>marketplace.service.wsdl</code>.
WSDL <code>ams-marketplace.service.wsdl</code> включает импорт базового <code>ApplicationManagementService_v2.1.wsdl</code> и <code>marketplace.service.wsdl</code>.


===Принципы взаимодействия===
===Принципы взаимодействия===


Работа с сервисом ApplicationManagementService выполняется в два шага, каждый шаг выполняется синхронно:
Работа с сервисом ApplicationManagementService выполняется в два шага (каждый шаг — синхронный):


*'''Шаг 1''' — подача заявки (<code>submitApplication</code>) с параметрами бизнес-операции и получение результата приёма заявки (идентификатор <code>applicationId</code>, статус <code>ACCEPTED</code>);
*'''Шаг 1''' — подача заявки (<code>submitApplication</code>) с параметрами бизнес-операции и получение результата приёма заявки (идентификатор <code>applicationId</code>, статус <code>ACCEPTED</code>);
Строка 129: Строка 131:
Каждый запрос дополнительно содержит <code>serviceId = marketplace.service:1.0</code> — общий код профиля, одинаковый для всех маркетплейсов.
Каждый запрос дополнительно содержит <code>serviceId = marketplace.service:1.0</code> — общий код профиля, одинаковый для всех маркетплейсов.


Логин и пароль, выданные при регистрации системы в ВетИС.API, используются только для подключения к сервису (базовая аутентификация) и НЕ передаются в <code>initiator.login</code> — поле <code>initiator.login</code> заполняется логином пользователя ВетИС, от имени которого выполняется запрос.
Логин и пароль, выданные при регистрации системы в ВетИС.API, используются только для подключения к сервису (базовая аутентификация) и НЕ передаются в <code>initiator.login</code> — это поле заполняется логином пользователя ВетИС, от имени которого выполняется запрос.


===Безопасность===
===Безопасность===
Строка 142: Строка 144:
#Юрлицо маркетплейса зарегистрировано в ФГИС «ВетИС» как хозяйствующий субъект;
#Юрлицо маркетплейса зарегистрировано в ФГИС «ВетИС» как хозяйствующий субъект;
#Система маркетплейса зарегистрирована в ВетИС.API как клиент; выданы логин и пароль;
#Система маркетплейса зарегистрирована в ВетИС.API как клиент; выданы логин и пароль;
#Выдан APIKey — ключ доступа к API;
# Выдан APIKey — ключ доступа к API;
#Маркетплейсу выдано право на профиль Marketplace.Services;
#Маркетплейсу выдано право на профиль Marketplace.Services;
#Для каждой заявки у маркетплейса есть <code>initiator.login</code> — логин зарегистрированного пользователя ВетИС, от имени которого выполняется запрос.
#Для каждой заявки у маркетплейса есть <code>initiator.login</code> — логин зарегистрированного пользователя ВетИС, от имени которого выполняется запрос.
Строка 149: Строка 151:


{| class="wikitable"
{| class="wikitable"
!Код операции!!Название операции / ссылка на спецификацию!!Описание операции
!Код операции!!Название операции / ссылка на спецификацию !!Описание операции
|-
|-
|AMS.MPLC.1.1
|AMS.MPLC.1.1
Строка 159: Строка 161:
|Проверка зарегистрированной номенклатуры товара
|Проверка зарегистрированной номенклатуры товара
|-
|-
|AMS.MPLC.1.3
|
AMS.MPLC.1.3
|[Marketplace:GetVetDocumentByUuid:v1.0]
|[Marketplace:GetVetDocumentByUuid:v1.0]
|Получение ветеринарного сопроводительного документа (ВСД) по уникальному идентификатору
|Получение ветеринарного сопроводительного документа (ВСД) по уникальному идентификатору  
|}
|}


Версия от 17:39, 13 октября 2026

Marketplace:Services:v1.0

Общие сведения

Профиль Marketplace.Services v1.0 — интеграционный профиль ВетИС.API для информационных систем операторов посреднических цифровых платформ (маркетплейсов).

Позволяет маркетплейсу получать из ФГИС «ВетИС» сведения, необходимые для проверки регистрации продавца, зарегистрированной номенклатуры товара и ветеринарного сопроводительного документа (ВСД).

Через профиль ФГИС «ВетИС» только передаёт сведения о регистрации. Решение о допуске продавца или карточки товара к размещению на платформе принимает сам маркетплейс.

Версии профиля API

  • v1.0 — Marketplace:Services:v1.0 (в разработке)

Предоставляемые сервисы

№ Сервис Описание
1 ApplicationManagementService Подсистема обработки заявок профиля

Структура XSD

Полные URI пространств имён указаны в самих XSD-схемах (передаются в составе пакета WSDL); в таблицах ниже приведены префиксы пространств.

Типы данных транспортного уровня (заявочный режим):

XSD-схема Пространство имён

application_v2.1.xsd

xmlns:apl
application_ws_definitions_v2.1.xsd xmlns:def
base_ws_definitions_v2.1.xsd xmlns:bsdef

Базовые типы данных:

XSD-схема Пространство имён
base_v2.1.xsd xmlns:bs

Прикладные типы данных:

XSD-схема

Пространство имён

dictionary_v2.6.xsd xmlns:dt
document_v2.6.xsd xmlns:vd
codelist_v2.6r12.xsd xmlns:cl

Типы данных профиля Marketplace.Services:

XSD-схема Пространство имён
marketplace_applications.xsd xmlns:mplc

ApplicationManagementService (подсистема обработки заявок)

Параметры подключения

Продуктивный контур

WSDL https://api.vetrf.ru/schema/platform/marketplace/v1.0b-last/ams-marketplace.service.wsdl
URL точки доступа (Endpoint) https://api.vetrf.ru/platform/services/2.1/ApplicationManagementService
Описание типов заявок включено в WSDL
Код сервиса (serviceId) marketplace.service:1.0

Тестовый контур

WSDL https://api2.vetrf.ru:8002/schema/platform/marketplace/v1.0b-last/ams-marketplace.service.wsdl
URL точки доступа (Endpoint) https://api2.vetrf.ru:8002/platform/services/2.1/ApplicationManagementService
Описание типов заявок включено в WSDL
Код сервиса (serviceId) marketplace.service:1.0

WSDL ams-marketplace.service.wsdl включает импорт базового ApplicationManagementService_v2.1.wsdl и marketplace.service.wsdl.

Принципы взаимодействия

Работа с сервисом ApplicationManagementService выполняется в два шага (каждый шаг — синхронный):

  • Шаг 1 — подача заявки (submitApplication) с параметрами бизнес-операции и получение результата приёма заявки (идентификатор applicationId, статус ACCEPTED);
  • Шаг 2 — подача запроса на получение результата (receiveApplicationResult) по applicationId: результат бизнес-операции (статус COMPLETED) либо сведения об ошибке (статус REJECTED).

Каждый запрос дополнительно содержит serviceId = marketplace.service:1.0 — общий код профиля, одинаковый для всех маркетплейсов.

Логин и пароль, выданные при регистрации системы в ВетИС.API, используются только для подключения к сервису (базовая аутентификация) и НЕ передаются в initiator.login — это поле заполняется логином пользователя ВетИС, от имени которого выполняется запрос.

Безопасность

  • Доступ к сервису ограничивается с помощью ключей доступа к API (APIKey).
  • Ключи доступа предоставляются при регистрации информационной системы маркетплейса в ВетИС.API как клиента.
  • APIKey идентифицирует информационную систему маркетплейса.
  • Перед проверкой APIKey выполняется базовая аутентификация с помощью логина и пароля, выданных при регистрации.

Предварительные условия до первого запроса

  1. Юрлицо маркетплейса зарегистрировано в ФГИС «ВетИС» как хозяйствующий субъект;
  2. Система маркетплейса зарегистрирована в ВетИС.API как клиент; выданы логин и пароль;
  3. Выдан APIKey — ключ доступа к API;
  4. Маркетплейсу выдано право на профиль Marketplace.Services;
  5. Для каждой заявки у маркетплейса есть initiator.login — логин зарегистрированного пользователя ВетИС, от имени которого выполняется запрос.

Операции, выполняемые через ApplicationManagementService

Код операции Название операции / ссылка на спецификацию Описание операции
AMS.MPLC.1.1 [Marketplace:CheckBusinessEntity:v1.0] Проверка регистрации хозяйствующего субъекта (продавца)
AMS.MPLC.1.2 [Marketplace:GetProductItemByGuid:v1.0] Проверка зарегистрированной номенклатуры товара

AMS.MPLC.1.3

[Marketplace:GetVetDocumentByUuid:v1.0] Получение ветеринарного сопроводительного документа (ВСД) по уникальному идентификатору

Ошибки профиля

При отклонении заявки в её ответе возвращается статус REJECTED, а в элементе apl:errors — текст ошибки и её код.

Профиль отклоняет заявку в следующих случаях:

  • информационная система передаёт операцию, отличную от трёх разрешённых профилем;
  • у информационной системы отсутствует право использования профиля.

Остальные ошибки (валидация и выполнение отдельных операций) описаны в разделе «Коды ошибок» спецификации каждой операции.

Источник — http://help.vetrf.ru/index.php?title=Marketplace:Services:v1.0&oldid=45614