Exportcenter:Services:v2.2: различия между версиями

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 58: Строка 58:


== Описание типов заявок (XSD-схемы) ==
== Описание типов заявок (XSD-схемы) ==
=== '''Последняя версия: v2.2b-20230322''' ===


{| class="wikitable"
{| class="wikitable"
|-
|-
! Последняя версия !! XSD !! Пространство имен  
! Версия !! XSD !! Пространство имен
|-
| v2.2b-20230322
| https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230322/base_v2.0.xsd
|| <nowiki>xmlns:bs="http://api.vetrf.ru/schema/cdm/base"</nowiki>
|-
| v2.2b-20230322
| https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230322/dictionary_v2.3.xsd
|| <nowiki>xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2"</nowiki>
|-
| v2.2b-20230322
| https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230322/document_v2.3.xsd
|| <nowiki>xmlns:vd="http://api.vetrf.ru/schema/cdm/mercury/vet-document/v2"</nowiki>
|-
| v2.2b-20230322
|| https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230322/exportcenter_applications_v2.2.xsd
|| <nowiki>xmlns:exc="http://api.vetrf.ru/schema/cdm/exportcenter/applications/v2"</nowiki>
|}
 
=== '''История версий''' ===
 
<br />
<div id="example6">
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
'''v2.2b-2023022'''
<div class = "mw-collapsible-content">
{| class="wikitable"
|-
! Версия !! XSD !! Пространство имен  
|-
|-
| v2.2b-2023022
| v2.2b-2023022
Строка 79: Строка 109:
|| <nowiki>xmlns:exc="http://api.vetrf.ru/schema/cdm/exportcenter/applications/v2"</nowiki>  
|| <nowiki>xmlns:exc="http://api.vetrf.ru/schema/cdm/exportcenter/applications/v2"</nowiki>  
|}
|}
</div>
</div>
<br />


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

Версия 00:07, 31 марта 2023

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

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

Сервис Описание
ApplicationManagementService Подсистема обработки заявок
EnterpriseService Сервис реестров хозяйствующих субъектов и предприятий
ProductService Сервис реестров категорий продукции
DictionaryService Сервис справочной информации
FMPRegistryService Сервис государственного реестра лекарственных препаратов ветеринарного применения, фармацевтических субстанций, кормов и кормовых добавок

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

WSDL https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230222/ams-exportcenter.service_v2.2.wsdl
URL точки доступа (Endpoint) https://{server}:{port}/platform/services/2.1/ApplicationManagementService
Описание типов заявок включено в WSDL
Код сервиса (serviceId) exportcenter.service:2.2

Описание типов заявок (XSD-схемы)

Последняя версия: v2.2b-20230322

Версия XSD Пространство имен
v2.2b-20230322 https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230322/base_v2.0.xsd xmlns:bs="http://api.vetrf.ru/schema/cdm/base"
v2.2b-20230322 https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230322/dictionary_v2.3.xsd xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2"
v2.2b-20230322 https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230322/document_v2.3.xsd xmlns:vd="http://api.vetrf.ru/schema/cdm/mercury/vet-document/v2"
v2.2b-20230322 https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230322/exportcenter_applications_v2.2.xsd xmlns:exc="http://api.vetrf.ru/schema/cdm/exportcenter/applications/v2"

История версий


v2.2b-2023022

Версия XSD Пространство имен
v2.2b-2023022 https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230222/base_v2.0.xsd xmlns:bs="http://api.vetrf.ru/schema/cdm/base"
v2.2b-2023022 https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230222/dictionary_v2.3.xsd xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2"
v2.2b-2023022 https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230222/document_v2.3.xsd xmlns:vd="http://api.vetrf.ru/schema/cdm/mercury/vet-document/v2"
v2.2b-2023022 https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230222/exportcenter_applications_v2.2.xsd xmlns:exc="http://api.vetrf.ru/schema/cdm/exportcenter/applications/v2"


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

Работа с сервисом ApplicationManagementService реализована по псевдо-асинхронному принципу и осуществляется в два шага, оба из которых выполняются синхронно:

  • 1 шаг – подача запроса с заявкой на выполнение бизнес-операции и получение результата приема заявки (идентификатора заявки);
  • 2 шаг – подача запроса на получение результата обработки заявки или результата выполнения бизнес-операции с использованием полученного на шаге 1 идентификатора заявки.

Для данной схемы действуют следующие правила:

  • Взаимодействие реализуется посредством запросов внешних информационных систем к ApplicationManagementService.
  • Любая операция в рамках информационного взаимодействия представляет собой заявку на выполнение бизнес-операции. Заявка от внешней информационной системы попадает в ApplicationManagementService, проходит форматно-логический контроль, регистрацию (ей присваивается уникальный идентификатор), маршрутизируется на целевой внутренний сервис, который выполняет операцию.
  • ApplicationManagementService позволяет отслеживать состояние данной заявки и получать результат ее выполнения.

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

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

Обработка заявок в ApplicationManagementService

  • Общий принцип работы с ApplicationManagementService, а также спецификации запросов/ответов подачи заявок и получения результатов обработки заявок, описаны здесь.

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

Номер операции Название операции / ссылка на спецификацию Описание операции
ЭВС:2.1. GetVetDocumentByUuid Получение ВСД по его идентификатору
ЭВС:2.2. GetPreExportVetDocumentList Получение списка ВСД на указанную партию продукции
ЭВС:7.2. SendCertifyEnterpriseForExportApplicationRequest Направление заявления на аттестацию предприятия на экспорт продукции или регистрацию поднадзорного объекта
ЭВС:7.3. CheckCertifyEnterpriseForExportApplicationRequest Получение сведений о результате рассмотрения заявления на аттестацию предприятия на экспорт продукции или регистрацию поднадзорного объекта
ЭВС:9.1. SendWBRComplianceApplication Направление заявления на получение Заключения о соответствии партии ВБР требованиям страны-импортера
ЭВС:9.2. CheckWBRComplianceApplication Получение сведений о результате рассмотрения заявления на получение Заключения о соответствии партии ВБР требованиям страны-импортера
ЭВС:9.3. ModifyWBRComplianceApplication Доработка заявления на получение Заключения о соответствии партии ВБР требованиям страны-импортера
ЭВС:13.1 FindLabResearchReport Проверка наличия протокола ЛИ по его номеру
ЭВС:13.2 SendLabResearchApplication Направление заявки на проведение лабораторных исследований
ЭВС:13.3 CheckLabResearchApplication Получение результатов проведения лабораторных исследований
ЭВС:13.4 GetSamplingReport Получение акта отбора проб
ЭВС:13.5 GetLabResearchReportByUuid Предоставление сведений из протоколов лабораторных испытаний, оформляемых для получения ветеринарного сертификата
ЭВС:14.5. AttachAccountingDocuments Передача сведений (документов) в контексте заявки

DictionaryService

WSDL https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230222/DictionaryService_v2.2.wsdl
URL точки доступа (тестовый контур) https://{server}:{port}/platform/exportcenter/services/2.2/DictionaryService

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

Сервис DictionaryService предназначен для получения справочной информации.

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

Номер операции Название операции / ссылка на спецификацию Описание операции
ЭВС:8.10 GetVeterinaryLaboratoryList Получение списка лабораторий

EnterpriseService

WSDL https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230222/EnterpriseService_v2.2.wsdl
URL точки доступа (Endpoint) https://{server}:{port}/platform/exportcenter/services/2.2/EnterpriseService

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

Сервис EnterpriseService предназначен для работы с реестром хозяйствующих субъектов и предприятий.

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

Номер операции Название операции / ссылка на спецификацию Описание операции
ЭВС:6.1 GetActivityLocationList Получение перечня мест осуществления деятельности (площадок отгрузки)
ЭВС:6.3 GetBESupervisedObjectList Получение перечня поднадзорных объектов хозяйствующего субъекта
ЭВС:6.4. GetRussianEnterpriseListRequest Получение сведений о зарегистрированных площадках
ЭВС:8.9. GetSupervisedObjectTypeListRequest Получение перечня видов поднадзорных объектов
ЭВС:8.11. GetSupervisedObjectActivityListRequest Получение перечня видов деятельности поднадзорных объектов
Источник — http://help.vetrf.ru/index.php?title=Exportcenter:Services:v2.2&oldid=36481