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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
 
(не показано 10 промежуточных версий 3 участников)
Строка 1: Строка 1:
=Версии профиля API=
=Версии профиля API=
* v2.2  – [[Exportcenter:Services:v2.2]]
* v2.2  – [[Exportcenter:Services:v2.2]]
** v2.2b-20230821
** v2.2b-20230717
** v2.2b-20230602
** v2.2b-20230602
** v2.2b-20230411
** v2.2b-20230411
Строка 43: Строка 45:
|-
|-
! scope="col" style="text-align:left;" | WSDL
! scope="col" style="text-align:left;" | WSDL
| https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230322/ams-exportcenter.service_v2.2.wsdl
| https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230602/ams-exportcenter.service_v2.2.wsdl
|-
|-
! scope="col" style="text-align:left;"| URL точки доступа (Endpoint)
! scope="col" style="text-align:left;"| URL точки доступа (Endpoint)
Строка 58: Строка 60:
== Описание типов заявок (XSD-схемы) ==
== Описание типов заявок (XSD-схемы) ==


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


{| class="wikitable"
|-
! Версия !! XSD !! Пространство имен
|-
| v2.2b-20230602
| https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230602/base_v2.0.xsd
|| <nowiki>xmlns:bs="http://api.vetrf.ru/schema/cdm/base"</nowiki>
|-
| v2.2b-20230602
| https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230602/dictionary_v2.3.xsd
|| <nowiki>xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2"</nowiki>
|-
| v2.2b-20230602
| https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230602/document_v2.3.xsd
|| <nowiki>xmlns:vd="http://api.vetrf.ru/schema/cdm/mercury/vet-document/v2"</nowiki>
|-
| v2.2b-20230602
|| https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230602/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-20230411'''
<div class = "mw-collapsible-content">
{| class="wikitable"
{| class="wikitable"
|-
|-
Строка 80: Строка 111:
|| <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 />


=== История версий ===
<br />
<div id="example6">
<div id="example6">
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Строка 250: Строка 281:
|-
|-
|}
|}
=Подсистема работы со справочниками и реестрами=


==DictionaryService==  
==DictionaryService==  
Строка 255: Строка 288:
|-
|-
! scope="col" style="text-align:left;" | WSDL
! scope="col" style="text-align:left;" | WSDL
| https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230411/DictionaryService_v2.2.wsdl
| https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230602/DictionaryService_v2.2.wsdl
|-
|-
! scope="col" style="text-align:left;"| URL точки доступа (Endpoint)
! scope="col" style="text-align:left;"| URL точки доступа (Endpoint)
Строка 294: Строка 327:
|-
|-
! scope="col" style="text-align:left;" | WSDL
! scope="col" style="text-align:left;" | WSDL
| https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230411/EnterpriseService_v2.2.wsdl  
| https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230602/EnterpriseService_v2.2.wsdl  
|-
|-
! scope="col" style="text-align:left;"| URL точки доступа (Endpoint)
! scope="col" style="text-align:left;"| URL точки доступа (Endpoint)
Строка 352: Строка 385:
|-
|-
! scope="col" style="text-align:left;" | WSDL
! scope="col" style="text-align:left;" | WSDL
| https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230411/ProductService_v2.2.wsdl
| https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230602/ProductService_v2.2.wsdl
|-
|-
! scope="col" style="text-align:left;"| URL точки доступа (Endpoint)
! scope="col" style="text-align:left;"| URL точки доступа (Endpoint)
Строка 409: Строка 442:
|| [[exportcenter:UploadAttachment:v2.2|UploadAttachment]]
|| [[exportcenter:UploadAttachment:v2.2|UploadAttachment]]
|| Загрузка файлов в хранилище
|| Загрузка файлов в хранилище
|-
|}
==FMPRegistryService==
{| class="wikitable"
|-
! scope="col" style="text-align:left;" | WSDL
| https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230602/FMPRegistryService_v2.2.wsdl
|-
! scope="col" style="text-align:left;"| URL точки доступа (тестовый контур)
| https://{server}:{port}/platform/exportcenter/services/2.2/FMPRegistryService
|-
|}
===Общие сведения===
Сервис '''FMPRegistryService''' предназначен для получения сведений из государственного реестра лекарственных препаратов ветеринарного назначения, фармацевтических субстанций, кормов и кормовых добавок.
===Операции, выполняемые через FMPRegistryService===
{| class="wikitable"
|-
! Номер операции !! Название операции / ссылка на спецификацию !! Описание операции
|-
| style="text-align:center;" |'''ССП:1.1'''
|| [[exportcenter:getMedicineRegistryEntryList:v2.0|GetMedicineRegistryEntryList]]
|| Получение списка записей реестров ЛП и ФС
|-
| style="text-align:center;" |'''ССП:2.1'''
|| [[exportcenter:getFodderRegistryEntryList:v2.0|GetFodderRegistryEntryList]]
|| Получение списка записей реестров КД и КГМО
|-
| style="text-align:center;" |'''ССП:1.2<br/>ССП:2.2'''
|| [[exportcenter:getRegistryEntryByGuid:v2.0|GetRegistryEntryByGuid]]
|| Получение записи реестра ЛП, ФС, КД или КГМО по ее идентификатору
|-
|-
|}
|}

Текущая версия на 10:06, 17 июня 2024

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

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

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

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

WSDL https://api.vetrf.ru/schema/platform/exportcenter/v2.2b-20230602/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-20230602

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

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


v2.2b-20230411

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


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-20230222

Версия XSD Пространство имен
v2.2b-20230222 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-20230222 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-20230222 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-20230222 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

Номер операции Название операции / ссылка на спецификацию Описание операции
ЭВС:1.1 RegisterLegalEntityApplication Направление заявки на регистрацию хозяйствующего субъекта и его уполномоченных лиц в ФГИС ВетИС для осуществления процедуры экспорта
ЭВС:1.2 CheckRegisterLegalEntityApplication Получение сведений о результате рассмотрения заявки на регистрацию хозяйствующего субъекта
ЭВС:2.1. GetVetDocumentByUuid Получение ВСД по его идентификатору
ЭВС:2.2. GetPreExportVetDocumentList Получение списка ВСД на указанную партию продукции
ЭВС:3.2 GetExportVeterinaryPermitList Получение списка действующих ветеринарных разрешений, выданных экспортеру
ЭВС:3.3 SendVeterinaryPermitApplication Направление заявления на оформление ветеринарного разрешения (вывоз) / внесение изменений и дополнений в выданное ветеринарное разрешение (вывоз)
ЭВС:3.4 CheckVeterinaryPermitApplication Проверка статуса заявления на оформление или внесение изменений в ветеринарное разрешение (вывоз)
ЭВС:3.5 ModifyVeterinaryPermitApplication Корректировка заявления на оформление ветеринарного разрешения (вывоз, при направлении на доработку)
ЭВС:4.1 SendExportCertificateApplication Направление заявки на оформление ветеринарных сопроводительных документов на экспорт
ЭВС:4.2 CheckExportCertificateApplication Получение сведений о результате рассмотрения заявки на оформление ветеринарных сопроводительных документов
ЭВС: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-20230602/DictionaryService_v2.2.wsdl
URL точки доступа (Endpoint) https://{server}:{port}/platform/exportcenter/services/2.2/DictionaryService

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

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

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

Номер операции Название операции / ссылка на спецификацию Описание операции
ЭВС:8.5 GetUnitList Получение полного перечня единиц измерений
ЭВС:8.6 GetVeterinaryBCPList Получение перечня ПВКП
ЭВС:8.7 GetPurposeList Получение списка целей вывоза
ЭВС:8.10 GetVeterinaryLaboratoryList Получение списка лабораторий

EnterpriseService

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

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

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

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

Номер операции Название операции / ссылка на спецификацию Описание операции
ЭВС:5.1 GetLegalEntityList Получение перечня хозяйствующих субъектов
ЭВС:5.2 GetLegalEntityChangesList Получение истории изменений реестра хозяйствующих субъектов
ЭВС:6.1 GetActivityLocationList Получение перечня мест осуществления деятельности (площадок отгрузки)
ЭВС:6.2 GetExportClearancePointList Получение перечня мест оформления ЭВС
ЭВС:6.3 GetBESupervisedObjectList Получение перечня поднадзорных объектов хозяйствующего субъекта
ЭВС:6.4. GetRussianEnterpriseListRequest Получение сведений о зарегистрированных площадках
ЭВС:7.1 GetCertifiedProducerList Получение полного списка предприятий, входящих в реестр экспортеров
ЭВС:8.9. GetSupervisedObjectTypeListRequest Получение перечня видов поднадзорных объектов
ЭВС:8.11. GetSupervisedObjectActivityListRequest Получение перечня видов деятельности поднадзорных объектов

ProductService

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

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

Сервис ProductService предназначен для получения реестра категорий продукции.

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

Номер операции Название операции / ссылка на спецификацию Описание операции
ЭВС:8.1 GetProductByTypeList Получение полного перечня продукции по типу
ЭВС:8.2 GetProductChangesList Получение истории изменений перечня продукции за указанный период
ЭВС:8.3 GetSubProductByProductList Получение полного перечня видов продукции по указанному 2-ому уровню справочника
ЭВС:8.4 GetSubProductChangesList Получение истории изменений перечня видов продукции за указанный период

ExcAttachmentService

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

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

Сервис ExcAttachmentService предназначен для загрузки файлов в хранилище и получения уникальных идентификаторов (ссылок) на файлы для дальнейшего использования в операциях.

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

Номер операции Название операции / ссылка на спецификацию Описание операции
- UploadAttachment Загрузка файлов в хранилище

FMPRegistryService

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

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

Сервис FMPRegistryService предназначен для получения сведений из государственного реестра лекарственных препаратов ветеринарного назначения, фармацевтических субстанций, кормов и кормовых добавок.

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

Номер операции Название операции / ссылка на спецификацию Описание операции
ССП:1.1 GetMedicineRegistryEntryList Получение списка записей реестров ЛП и ФС
ССП:2.1 GetFodderRegistryEntryList Получение списка записей реестров КД и КГМО
ССП:1.2
ССП:2.2 		GetRegistryEntryByGuid Получение записи реестра ЛП, ФС, КД или КГМО по ее идентификатору
Источник — http://help.vetrf.ru/index.php?title=Exportcenter:Services:v2.2&oldid=40410