Exportcenter:Services:v2.1: различия между версиями
Перейти к навигации
Перейти к поиску
(не показаны 44 промежуточные версии 2 участников) | |||
Строка 1: | Строка 1: | ||
=Версии профиля API= | =Версии профиля API= | ||
* v2.2 – [[Exportcenter:Services:v2.2]] | |||
** v2.2b-20230411 | |||
** v2.2b-20230322 | |||
** v2.2b-20230222 | |||
* v2.1 – [[Exportcenter:Services:v2.1]] | * v2.1 – [[Exportcenter:Services:v2.1]] | ||
** v2.1b-20220530 | ** v2.1b-20220530 | ||
** v2.1b-20220525 | ** v2.1b-20220525 | ||
** v2.1b-20221115 | |||
*v2.0 – [[Exportcenter:Services:v2.0]] | *v2.0 – [[Exportcenter:Services:v2.0]] | ||
** v2.0b-20220316 | ** v2.0b-20220316 | ||
Строка 40: | Строка 45: | ||
|- | |- | ||
! scope="col" style="text-align:left;" | WSDL | ! scope="col" style="text-align:left;" | WSDL | ||
| https://api.vetrf.ru/schema/platform/exportcenter/v2. | | https://api.vetrf.ru/schema/platform/exportcenter/v2.1-20221220/ams-exportcenter.service_v2.1.wsdl | ||
|- | |- | ||
! scope="col" style="text-align:left;"| URL точки доступа (Endpoint) | ! scope="col" style="text-align:left;"| URL точки доступа (Endpoint) | ||
| https://{server}:{port}/platform | | https://{server}:{port}/platform/services/2.1/ApplicationManagementService | ||
|- | |- | ||
! scope="col" style="text-align:left;"| Описание типов заявок | ! scope="col" style="text-align:left;"| Описание типов заявок | ||
Строка 51: | Строка 56: | ||
| exportcenter.service:2.1 | | exportcenter.service:2.1 | ||
|- | |- | ||
|} | |||
== Описание типов заявок (XSD-схемы) == | |||
{| class="wikitable" | |||
|- | |||
! Последняя версия !! XSD !! Пространство имен | |||
|- | |||
| v2.1-20230123 | |||
| https://api.vetrf.ru/schema/platform/exportcenter/v2.1-20230123/base_v2.0.xsd | |||
|| <nowiki>xmlns:bs="http://api.vetrf.ru/schema/cdm/base"</nowiki> | |||
|- | |||
| v2.1-20230123 | |||
| https://api.vetrf.ru/schema/platform/exportcenter/v2.1-20230123/dictionary_v2.3.xsd | |||
|| <nowiki>xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2"</nowiki> | |||
|- | |||
| v2.1-20230123 | |||
| https://api.vetrf.ru/schema/platform/exportcenter/v2.1-20230123/document_v2.3.xsd | |||
|| <nowiki>xmlns:vd="http://api.vetrf.ru/schema/cdm/mercury/vet-document/v2"</nowiki> | |||
|- | |||
| v2.1-20230123 | |||
|| https://api.vetrf.ru/schema/platform/exportcenter/v2.1-20230123/exportcenter_applications_v2.1.xsd | |||
|| <nowiki>xmlns:exc="http://api.vetrf.ru/schema/cdm/exportcenter/applications/v2"</nowiki> | |||
|} | |} | ||
Строка 119: | Строка 147: | ||
|- | |- | ||
| style="text-align:center;" |'''СУБС:11''' | | style="text-align:center;" |'''СУБС:11''' | ||
'''ЭВС:13.5''' | |||
|| [[Exportcenter:GetLabResearchReportByUuid:v2.0|GetLabResearchReportByUuid]] | || [[Exportcenter:GetLabResearchReportByUuid:v2.0|GetLabResearchReportByUuid]] | ||
|| Предоставление сведений из протоколов лабораторных испытаний, оформляемых для получения ветеринарного сертификата | || Предоставление сведений из протоколов лабораторных испытаний, оформляемых для получения ветеринарного сертификата | ||
|- | |||
|} | |} | ||
Строка 130: | Строка 160: | ||
|- | |- | ||
! scope="col" style="text-align:left;" | WSDL | ! scope="col" style="text-align:left;" | WSDL | ||
| https://api.vetrf.ru/schema/platform/exportcenter/v2. | | https://api.vetrf.ru/schema/platform/exportcenter/v2.1-20221220/EnterpriseService_v2.1.wsdl | ||
|- | |- | ||
! scope="col" style="text-align:left;"| URL точки доступа (Endpoint) | ! scope="col" style="text-align:left;"| URL точки доступа (Endpoint) | ||
Строка 165: | Строка 195: | ||
|| [[Exportcenter:GetBESupervisedObjectList:v2.1|GetBESupervisedObjectList]] | || [[Exportcenter:GetBESupervisedObjectList:v2.1|GetBESupervisedObjectList]] | ||
|| Получение перечня поднадзорных объектов хозяйствующего субъекта | || Получение перечня поднадзорных объектов хозяйствующего субъекта | ||
|- | |||
| style="text-align:center;" |'''ЭВС:6.4.''' | |||
|| [[Exportcenter:GetRussianEnterpriseListRequest:v2.1|GetRussianEnterpriseListRequest]] | |||
|| Получение сведений о зарегистрированных площадках | |||
|- | |- | ||
| style="text-align:center;" |'''ЭВС:7.1''' | | style="text-align:center;" |'''ЭВС:7.1''' | ||
|| [[Exportcenter:GetCertifiedProducerList:v2.0|GetCertifiedProducerList]] | || [[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]] | |||
|| Получение перечня видов деятельности поднадзорных объектов | |||
|- | |- | ||
|} | |} | ||
Строка 176: | Строка 218: | ||
|- | |- | ||
! scope="col" style="text-align:left;" | WSDL | ! scope="col" style="text-align:left;" | WSDL | ||
| https://api.vetrf.ru/schema/platform/exportcenter/v2. | | https://api.vetrf.ru/schema/platform/exportcenter/v2.1-20221220/ProductService_v2.1.wsdl | ||
|- | |- | ||
! scope="col" style="text-align:left;"| URL точки доступа (тестовый контур) | ! scope="col" style="text-align:left;"| URL точки доступа (тестовый контур) | ||
Строка 214: | Строка 256: | ||
|- | |- | ||
! scope="col" style="text-align:left;" | WSDL | ! scope="col" style="text-align:left;" | WSDL | ||
| https://api.vetrf.ru/schema/platform/exportcenter/v2. | | https://api.vetrf.ru/schema/platform/exportcenter/v2.1-20221220/DictionaryService_v2.1.wsdl | ||
|- | |- | ||
! scope="col" style="text-align:left;"| URL точки доступа (тестовый контур) | ! scope="col" style="text-align:left;"| URL точки доступа (тестовый контур) | ||
Строка 248: | Строка 290: | ||
|- | |- | ||
! scope="col" style="text-align:left;" | WSDL | ! scope="col" style="text-align:left;" | WSDL | ||
| https://api.vetrf.ru/schema/platform/exportcenter/v2.1b- | | https://api.vetrf.ru/schema/platform/exportcenter/v2.1b-20221115/FMPRegistryService_v2.1.wsdl | ||
|- | |- | ||
! scope="col" style="text-align:left;"| URL точки доступа (тестовый контур) | ! scope="col" style="text-align:left;"| URL точки доступа (тестовый контур) | ||
| https:// | | https://{server}:{port}/platform/exportcenter/services/2.1/FMPRegistryService | ||
|- | |- | ||
|} | |} |
Текущая версия на 16:26, 12 апреля 2023
Версии профиля API
- v2.2 – Exportcenter:Services:v2.2
- v2.2b-20230411
- v2.2b-20230322
- v2.2b-20230222
- 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.1-20221220/ams-exportcenter.service_v2.1.wsdl |
---|---|
URL точки доступа (Endpoint) | https://{server}:{port}/platform/services/2.1/ApplicationManagementService |
Описание типов заявок | включено в WSDL |
Код сервиса (serviceId) | exportcenter.service:2.1 |
Описание типов заявок (XSD-схемы)
Последняя версия | XSD | Пространство имен |
---|---|---|
v2.1-20230123 | https://api.vetrf.ru/schema/platform/exportcenter/v2.1-20230123/base_v2.0.xsd | xmlns:bs="http://api.vetrf.ru/schema/cdm/base" |
v2.1-20230123 | https://api.vetrf.ru/schema/platform/exportcenter/v2.1-20230123/dictionary_v2.3.xsd | xmlns:dt="http://api.vetrf.ru/schema/cdm/dictionary/v2" |
v2.1-20230123 | https://api.vetrf.ru/schema/platform/exportcenter/v2.1-20230123/document_v2.3.xsd | xmlns:vd="http://api.vetrf.ru/schema/cdm/mercury/vet-document/v2" |
v2.1-20230123 | https://api.vetrf.ru/schema/platform/exportcenter/v2.1-20230123/exportcenter_applications_v2.1.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 СУБС:12 |
GetVetDocumentByUuid | Получение предэкспортного ВСД по его идентификатору |
ЭВС:2.2 | GetPreExportVetDocumentList | Получение списка предэкспортных ВСД на указанную партию продукции |
ЭВС:3.2 | GetExportVeterinaryPermitList | Получение списка действующих ветеринарных разрешений, выданных экспортеру |
ЭВС:3.3 | SendVeterinaryPermitApplication | Направление заявления на оформление ветеринарного разрешения (вывоз) / внесение изменений и дополнений в выданное ветеринарное разрешение (вывоз) |
ЭВС:3.4 | CheckVeterinaryPermitApplication | Проверка статуса заявления на оформление или внесение изменений в ветеринарное разрешение (вывоз) |
ЭВС:3.5 | ModifyVeterinaryPermitApplication | Корректировка заявления на оформление ветеринарного разрешения (вывоз, при направлении на доработку) |
ЭВС:4.1 | SendExportCertificateApplication | Направление заявки на оформление ветеринарных сопроводительных документов на экспорт |
ЭВС:4.2 | CheckExportCertificateApplication | Получение сведений о результате рассмотрения заявки на оформление ветеринарных сопроводительных документов |
СУБС:11
ЭВС:13.5 |
GetLabResearchReportByUuid | Предоставление сведений из протоколов лабораторных испытаний, оформляемых для получения ветеринарного сертификата |
Подсистема работы со справочниками и реестрами
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.1-20221220/ProductService_v2.1.wsdl |
---|---|
URL точки доступа (тестовый контур) | https://{server}:{port}/platform/exportcenter/services/2.1/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.1-20221220/DictionaryService_v2.1.wsdl |
---|---|
URL точки доступа (тестовый контур) | https://{server}:{port}/platform/exportcenter/services/2.1/DictionaryService |
Общие сведения
Сервис DictionaryService предназначен для получения справочной информации.
Операции, выполняемые через DictionaryService
Номер операции | Название операции / ссылка на спецификацию | Описание операции |
---|---|---|
ЭВС:8.5 | GetUnitList | Получение полного перечня единиц измерений |
ЭВС:8.6 | GetVeterinaryBCPList | Получение перечня ПВКП |
ЭВС:8.7 | GetPurposeList | Получение списка целей вывоза |
FMPRegistryService
Общие сведения
Сервис FMPRegistryService предназначен для получения сведений из государственного реестра лекарственных препаратов ветеринарного назначения, фармацевтических субстанций, кормов и кормовых добавок.
Операции, выполняемые через FMPRegistryService
Номер операции | Название операции / ссылка на спецификацию | Описание операции |
---|---|---|
ССП:1.1 | GetMedicineRegistryEntryList | Получение списка записей реестров ЛП и ФС |
ССП:2.1 | GetFodderRegistryEntryList | Получение списка записей реестров КД и КГМО |
ССП:1.2 ССП:2.2 |
GetRegistryEntryByGuid | Получение записи реестра ЛП, ФС, КД или КГМО по ее идентификатору |