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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
(Перенаправление на Exportcenter:Services:v2.0)
Метка: новое перенаправление
 
(не показано 29 промежуточных версий 3 участников)
Строка 1: Строка 1:
=Предоставляемые сервисы=
#REDIRECT [[Exportcenter:Services:v2.0]]
 
{| class="wikitable"
|-
! Сервис !! Описание
|-
| '''ApplicationManagementService'''
| Подсистема обработки заявок
|-
| '''EnterpriseService'''
| Сервис реестров хозяйствующих субъектов и предприятий
|-
| '''ProductService'''
| Сервис реестров категорий продукции
|-
| '''DictionaryService'''
| Сервис справочной информации
|-
|}
 
=Подсистема обработки заявок (ApplicationManagementService)=
 
{| class="wikitable"
|-
! scope="col" style="text-align:left;" | WSDL
| https://api.vetrf.ru/schema/platform/exportcenter/v2.0b-20210906/ams-exportcenter.service_v2.0.wsdl
|-
! scope="col" style="text-align:left;"| URL точки доступа (Endpoint)
| https://{server}:{port}/platform/services/2.0/ApplicationManagementService
|-
! scope="col" style="text-align:left;"| Описание типов заявок
| включено в WSDL
|-
! scope="col" style="text-align:left;"| Код сервиса ([[Exportcenter:ApplicationManagementService#.D0.9F.D0.BE.D0.B4.D0.B0.D1.87.D0.B0_.D0.B7.D0.B0.D1.8F.D0.B2.D0.BA.D0.B8|serviceId]])
|
|-
|}
 
==Принципы взаимодействия==
Работа с сервисом '''ApplicationManagementService''' реализована по псевдо-асинхронному принципу и осуществляется в два шага, оба из которых выполняются синхронно:
* '''1 шаг''' – подача запроса с заявкой на выполнение бизнес-операции и получение результата приема заявки (идентификатора заявки);
* '''2 шаг''' – подача запроса на получение результата обработки заявки/выполнения бизнес-операции с использованием полученного на шаге 1 идентификатора заявки.
 
Для данной схемы действуют следующие правила:
* Взаимодействие реализуется посредством запросов внешних информационных систем к ApplicationManagementService.
* Любая операция в рамках информационного взаимодействия представляет собой заявку на выполнение бизнес-операции. Заявка от внешней информационной системы попадает в ApplicationManagementService, проходит форматно-логический контроль, регистрацию (ей присваивается уникальный идентификатор), маршрутизируется на целевой внутренний сервис, который выполняет операцию.
* ApplicationManagementService позволяет отслеживать состояние данной заявки и получать результат ее выполнения.
 
==Безопасность==
* Доступ к сервису ApplicationManagementService ограничивается с помощью ключей доступа к API (APIKey).
* Ключи доступа предоставляются при регистрации внешней информационной системы в качестве клиента "Ветис.API".
* APIKey - ключ, который идентифицирует клиентскую информационную систему. В сочетании с идентификатором пользователя (issuerId), этот ключ позволяет получать доступ к информации о клиенте сервиса.
* Перед проверкой APIKey производится базовая аутентификация с помощью логина и пароля, предоставляемых в ответном письме при получении доступа. Процесс авторизации описан [[Процесс авторизации в шлюзе|здесь]].
 
==Обработка заявок в ApplicationManagementService==
* Общий принцип работы с ApplicationManagementService, а также '''спецификации запросов/ответов подачи заявок и получения результатов обработки заявок''', описаны [[Exportcenter:ApplicationManagementService|здесь]].
 
==Операции, выполняемые через ApplicationManagementService==
 
{| class="wikitable"
|-
! Номер операции !! Название операции / ссылка на спецификацию !! Описание операции
|-
| style="text-align:center;" |'''1.1'''
|| [[Exportcenter:RegisterLegalEntityApplication|RegisterLegalEntityApplication]]
|| Направление заявки на регистрацию хозяйствующего субъекта и его уполномоченных лиц в ФГИС ВетИС для осуществления процедуры экспорта 
|-
| style="text-align:center;" |'''1.2'''
|| [[Exportcenter:CheckRegisterLegalEntityApplication|CheckRegisterLegalEntityApplication]]
|| Получение сведений о результате рассмотрения заявки на регистрацию хозяйствующего субъекта
|-
| style="text-align:center;" |'''2.1'''
|| [[Exportcenter:GetVetDocumentByUuid|GetVetDocumentByUuid]]
|| Получение предэкспортного ВСД по его идентификатору
|-
| style="text-align:center;" |'''2.2'''
|| [[Exportcenter:GetPreExportVetDocumentList|GetPreExportVetDocumentList]]
|| Получение списка предэкспортных ВСД на указанную партию продукции
|-
| style="text-align:center;" |'''3.2'''
|| [[Exportcenter:GetExportVeterinaryPermitList|GetExportVeterinaryPermitList]]
|| Получение списка действующих ветеринарных разрешений, выданных экспортеру
|-
| style="text-align:center;" |'''4.1'''
|| [[Exportcenter:SendExportCertificateApplication|SendExportCertificateApplication]]
|| Направление заявки на оформление ветеринарных сопроводительных документов на экспорт
|-
| style="text-align:center;" |'''4.2'''
|| [[Exportcenter:CheckExportCertificateApplication|CheckExportCertificateApplication]]
|| Получение сведений о результате рассмотрения заявки на оформление ветеринарных сопроводительных документов
|}
 
=Подсистема работы со справочниками и реестрами=
 
==EnterpriseService==
 
{| class="wikitable"
|-
! scope="col" style="text-align:left;" | WSDL
| https://api.vetrf.ru/schema/platform/exportcenter/v2.0b-20210906/EnterpriseService_v2.0.wsdl
|-
! scope="col" style="text-align:left;"| URL точки доступа (Endpoint)
| https://{server}:{port}/platform/exportcenter/services/2.0/EnterpriseService
|-
|}
 
===Общие сведения===
Сервис EnterpriseService предназначен для работы с реестром хозяйствующих субъектов и предприятий.
 
===Операции, выполняемые через EnterpriseService===
 
{| class="wikitable"
|-
! Номер операции !! Название операции / ссылка на спецификацию !! Описание операции
|-
| style="text-align:center;" |'''5.1'''
|| [[Exportcenter:GetLegalEntityList|GetLegalEntityList]]
|| Получение перечня хозяйствующих субъектов 
|-
| style="text-align:center;" |'''5.2'''
|| [[Exportcenter:GetLegalEntityChangesList|GetLegalEntityChangesList]]
|| Получение истории изменений реестра хозяйствующих субъектов 
|-
| style="text-align:center;" |'''6.1'''
|| [[Exportcenter:GetActivityLocationList|GetActivityLocationList]]
|| Получение перечня мест осуществления деятельности (площадок отгрузки)
|-
| style="text-align:center;" |'''6.2'''
|| [[Exportcenter:GetExportClearancePointList|GetExportClearancePointList]]
|| Получение перечня мест оформления ЭВС
|-
|}
 
==ProductService==
{| class="wikitable"
|-
! scope="col" style="text-align:left;" | WSDL
| https://api.vetrf.ru/schema/platform/exportcenter/v2.0b-20210906/ProductService_v2.0.wsdl
|-
! scope="col" style="text-align:left;"| URL точки доступа (Endpoint)
| https://{server}:{port}/platform/exportcenter/services/2.0/ProductService
|-
|}
===Общие сведения===
 
Сервис '''ProductService''' предназначен для получения реестра категорий продукции.
 
===Операции, выполняемые через ProductService===
 
{| class="wikitable"
|-
! Номер операции !! Название операции / ссылка на спецификацию !! Описание операции
|-
| style="text-align:center;" |'''8.1'''
|| [[exportcenter:GetProductByTypeList:v2.0|GetProductByTypeList]]
|| Получение полного перечня продукции по типу
|-
| style="text-align:center;" |'''8.2'''
|| [[exportcenter:GetProductChangesList:v2.0|GetProductChangesList]]
|| Получение истории изменений перечня продукции за указанный период
|-
| style="text-align:center;" |'''8.3'''
|| [[exportcenter:GetSubProductByProductList:v2.0|GetSubProductByProductList]]
|| Получение полного перечня видов продукции по указанному 2-ому уровню справочника
|-
| style="text-align:center;" |'''8.4'''
|| [[exportcenter:GetSubProductChangesList:v2.0|GetSubProductChangesList]]
|| Получение истории изменений перечня видов продукции за указанный период
|-
|}
 
==DictionaryService==
 
===Общие сведения===
 
Сервис '''DictionaryService''' предназначен для получения справочной информации.
 
===Операции, выполняемые через DictionaryService===
 
{| class="wikitable"
|-
! Номер операции !! Название операции / ссылка на спецификацию !! Описание операции
|-
| style="text-align:center;" |'''8.5'''
|| [[exportcenter:getUnitList:v2.0|GetUnitList]]
|| Получение полного перечня единиц измерений
|-
| style="text-align:center;" |'''8.6'''
|| [[exportcenter:GetVeterinaryBCPList:v2.0|GetVeterinaryBCPList]]
|| Получение перечня ПВКП
|-
|}

Текущая версия на 08:49, 2 июня 2022

Перенаправление на: