Exportcenter:Services:v2.2: различия между версиями
Перейти к навигации
Перейти к поиску
Строка 181: | Строка 181: | ||
|| [[exportcenter:GetVeterinaryLaboratoryList:v2.2|GetVeterinaryLaboratoryList]] | || [[exportcenter:GetVeterinaryLaboratoryList:v2.2|GetVeterinaryLaboratoryList]] | ||
|| Получение списка лабораторий | || Получение списка лабораторий | ||
|- | |||
|} | |||
==EnterpriseService== | |||
{| class="wikitable" | |||
|- | |||
! scope="col" style="text-align:left;" | WSDL | |||
| https://api.vetrf.ru/schema/platform/exportcenter/v2.1-20221220/EnterpriseService_v2.1.wsdl | |||
|- | |||
! scope="col" style="text-align:left;"| URL точки доступа (Endpoint) | |||
| https://{server}:{port}/platform/exportcenter/services/2.1/EnterpriseService | |||
|- | |||
|} | |||
===Общие сведения=== | |||
Сервис EnterpriseService предназначен для работы с реестром хозяйствующих субъектов и предприятий. | |||
===Операции, выполняемые через EnterpriseService=== | |||
{| class="wikitable" | |||
|- | |||
! Номер операции !! Название операции / ссылка на спецификацию !! Описание операции | |||
|- | |||
| style="text-align:center;" |'''ЭВС:5.1''' | |||
|| [[Exportcenter:GetLegalEntityList:v2.0|GetLegalEntityList]] | |||
|| Получение перечня хозяйствующих субъектов | |||
|- | |||
| style="text-align:center;" |'''ЭВС:5.2''' | |||
|| [[Exportcenter:GetLegalEntityChangesList:v2.0|GetLegalEntityChangesList]] | |||
|| Получение истории изменений реестра хозяйствующих субъектов | |||
|- | |||
| style="text-align:center;" |'''ЭВС:6.1''' | |||
|| [[Exportcenter:GetActivityLocationList:v2.0|GetActivityLocationList]] | |||
|| Получение перечня мест осуществления деятельности (площадок отгрузки) | |||
|- | |||
| style="text-align:center;" |'''ЭВС:6.2''' | |||
|| [[Exportcenter:GetExportClearancePointList:v2.0|GetExportClearancePointList]] | |||
|| Получение перечня мест оформления ЭВС | |||
|- | |||
| style="text-align:center;" |'''ЭВС:6.3''' | |||
|| [[Exportcenter:GetBESupervisedObjectList:v2.1|GetBESupervisedObjectList]] | |||
|| Получение перечня поднадзорных объектов хозяйствующего субъекта | |||
|- | |||
| style="text-align:center;" |'''ЭВС:6.4.''' | |||
|| [[Exportcenter:GetRussianEnterpriseListRequest:v2.1|GetRussianEnterpriseListRequest]] | |||
|| Получение сведений о зарегистрированных площадках | |||
|- | |||
| style="text-align:center;" |'''ЭВС:7.1''' | |||
|| [[Exportcenter:GetCertifiedProducerList:v2.0|GetCertifiedProducerList]] | |||
|| Получение полного списка предприятий, входящих в реестр экспортеров | |||
|- | |||
| style="text-align:center;" |'''ЭВС:8.9.''' | |||
|| [[Exportcenter:GetSupervisedObjectTypeListRequest:v2.1|GetSupervisedObjectTypeListRequest]] | |||
|| Получение перечня видов поднадзорных объектов | |||
|- | |||
| style="text-align:center;" |'''ЭВС:8.11.''' | |||
|| [[Exportcenter:GetSupervisedObjectActivityListRequest:v2.1|GetSupervisedObjectActivityListRequest]] | |||
|| Получение перечня видов деятельности поднадзорных объектов | |||
|- | |- | ||
|} | |} |
Версия 00:09, 24 марта 2023
Версии профиля API
- v2.2 – Exportcenter:Services:v2.2
- v2.2b-2023022
- v2.1 – Exportcenter:Services:v2.1
- v2.1b-20220530
- v2.1b-20220525
- v2.1b-20221115
- v2.0 – Exportcenter:Services:v2.0
- v2.0b-20220316
- v2.0b-20220123
- v2.0b-20211206
- v2.0b-20211126
- v2.0b-20210920
- v2.0b-20210912
- v2.0b-20210906
Предоставляемые сервисы
Сервис | Описание |
---|---|
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-схемы)
Последняя версия | 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
Общие сведения
Сервис 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 | Получение перечня видов деятельности поднадзорных объектов |