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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
Строка 140: Строка 140:
|-
|-
! scope="col" style="text-align:left;" | WSDL
! scope="col" style="text-align:left;" | WSDL
| https://api.vetrf.ru/schema/platform/exportcenter/v2.0b-20210906/ProductService_v2.0.wsdl
| https://api.vetrf.ru/schema/platform/exportcenter/v2.0b-20210912/ProductService_v2.0.wsdl
|-
|-
! scope="col" style="text-align:left;"| URL точки доступа (Endpoint)
! scope="col" style="text-align:left;"| URL точки доступа (Endpoint)

Версия 08:07, 15 сентября 2021

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

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

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

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

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

Работа с сервисом 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 Получение списка действующих ветеринарных разрешений, выданных экспортеру
4.1 SendExportCertificateApplication Направление заявки на оформление ветеринарных сопроводительных документов на экспорт
4.2 CheckExportCertificateApplication Получение сведений о результате рассмотрения заявки на оформление ветеринарных сопроводительных документов

Подсистема работы со справочниками и реестрами

EnterpriseService

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

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

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

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

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

ProductService

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

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

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

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

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

DictionaryService

WSDL https://api.vetrf.ru/schema/platform/exportcenter/v2.0b-20210906/DictionaryService_v2.0.wsdl
URL точки доступа (Endpoint) https://{server}:{port}/platform/exportcenter/services/2.0/DictionaryService

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

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

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

Номер операции Название операции / ссылка на спецификацию Описание операции
8.5 GetUnitList Получение полного перечня единиц измерений
8.6 GetVeterinaryBCPList Получение перечня ПВКП