Компонент Ветис.API

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску

Основное назначение

Универсальный шлюз Ветис.API предоставляет возможность сторонним информационным системам обмениваться информацией с компонентами Ветис для выполнения прикладных задач, получения справочной информации и сведений из реестров.

Цели создания

  • Расширение возможностей платформы Ветис и ее компонентов за счет подключения сторонних информационных систем.
  • Автоматизация взаимодействия системы Меркурий с учетными системами хозяйствующих субъектов и ветеринарных служб субъектов для решения задач электронной ветеринарной сертификации.

Использование/возможности

Взаимодействие с компонентом Меркурий

Ветис.API позволяет сторонним информационным системам передавать информацию, необходимую для формирования электронных ветеринарных сертификатов в компоненте Меркурий, получать информацию об оформленных электронных сертификатах из компонента Меркурий.

ApplicationManagementService предоставляет следующие операции: оформление производственной партии; оформление транспортной партии; оформление входящей партии; оформление результатов инвентаризации; объединение записей складского журнала; получение ВСД по его идентификатору; получение ВСД, созданных или измененных за указанный интервал дат (получение истории изменений); получение всех ВСД предприятия с возможностью фильтрации; получение конкретной версии записи складского журнала по ее идентификатору; получение последней (актуальной) версии записи складского журнала по ее идентификатору; получение всех версий записи складского журнала по ее идентификатору; получение актуального списка записей журнала; получение списка версий записей журнала, созданных или измененных за указанный интервал дат (получение истории изменений); добавление/изменение сведений о хозяйствующем субъекте; добавление/изменение сведений о поднадзорном объекте; аннулирование ВСД; создание/удаление связи с площадкой; добавление номенклатуры производителя в справочник.

Подробное описание предоставляемых бизнес-операций можно найти в статье "Подсистема обработки заявок в Ветис.API" / "Меркурий".

Взаимодействие с компонентом Хорриот

Ветис.API позволяет сторонним информационным системам передавать информацию, необходимую для регистрации животных в компоненте Хорриот, получать информацию о зарегистрированных животных и выполнять другие операции, предусмотренные в компоненте Хорриот.

Подробное описание предоставляемых в рамках сервиса ApplicationManagementService бизнес-операций кмомпонента Хорриот можно найти в статье "Подсистема обработки заявок в Ветис.API" / "Хорриот". Спецификация форматов взаимодействия: herriot.service:1.0

Взаимодействие с компонентом Цербер

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

Сервис предоставляет следующие операции: Получение списка ХС, Получение объекта ХС по его глобальному идентификатору, Получение записи ХС по ее идентификатору, Получение истории изменений списка ХС, Получение списка зарубежных предприятий, Получение списка российских предприятий, Получение записи предприятия по его глобальному идентификатору, Получение записи предприятия по ее идентификатору, Получение истории изменений списка зарубежных предприятий, Получение истории изменений списка российских предприятий.

Взаимодействие с компонентом Икар

IkarService позволяет получать информацию из единого хранилища адресных данных, которые используются в информационных системах Россельхознадзора.

Сервис предоставляет следующие операции: Получение списка стран, Получение объекта страны по его глобальному идентификатору, Получение записи страны по ее идентификатору, Получение истории изменений списка стран, Получение списка регионов по стране, Получение объекта региона по его глобальному идентификатору, Получение записи региона по ее идентификатору, Получение истории изменений списка регионов, Получение списка районов по региону, Получение объекта района по его глобальному идентификатору, Получение истории изменений списка районов.

Структура

Шлюз состоит из двух подсистем:

Рис. 1. Структура Ветис.API

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

Это сервис для выполнения бизнес-операций в специализированных компонентах Аргус, Меркурий, Веста и т.д. В подсистеме реализован сервис ApplicationManagementService суть работы которого заключается в приеме, авторизации и маршрутизации заявки к тому или иному целевому специализированному компоненту. Работа с этим сервисом реализована по псевдо-асинхронному принципу и осуществляется в два шага:

1 шаг – подача заявки на выполнение бизнес-операции, получение результата приема заявки (выполняется синхронно);

2 шаг – подача запроса на получение результатов обработки заявки/выполнения бизнес-операции (выполняется синхронно).

Подробно форматы запросов на подачу заявки и получение результатов ее обработки описаны в статье Подсистема обработки заявок в Ветис.API.

Сервис обработки заявок для хозяйствующих субъектов

Версия Продуктивный контур Тестовый контур
v2.0 WSDL: http://api.vetrf.ru/schema/platform/services/2.0-last/ams-mercury-g2b.service_v2.0_production.wsdl
Описание типов заявок: включено в WSDL
ServiceId: mercury-g2b.service:2.0
URL точки доступа: https://api.vetrf.ru/platform/services/2.0/ApplicationManagementService 		WSDL: http://api.vetrf.ru/schema/platform/services/2.0-RC-last/ams-mercury-g2b.service_v2.0_pilot.wsdl
Описание типов заявок: включено в WSDL
ServiceId: mercury-g2b.service:2.0
URL точки доступа: https://api2.vetrf.ru:8002/platform/services/2.0/ApplicationManagementService
v2.1 WSDL: http://api.vetrf.ru/schema/platform/services/2.1-RC-last/ams-mercury-g2b.service_v2.1_production.wsdl
Описание типов заявок: включено в WSDL
ServiceId: mercury-g2b.service:2.1
URL точки доступа: https://api.vetrf.ru/platform/services/2.1/ApplicationManagementService 		WSDL: http://api.vetrf.ru/schema/platform/services/2.1-RC-last/ams-mercury-g2b.service_v2.1_pilot.wsdl
Описание типов заявок: включено в WSDL
ServiceId: mercury-g2b.service:2.1
URL точки доступа: https://api2.vetrf.ru:8002/platform/services/2.1/ApplicationManagementService
  • Версия сервиса определяется в первую очередь по serviceId.

Сервис обработки заявок для ветеринарных управлений

Версия Продуктивный контур Тестовый контур
v2.0 WSDL:
http://api.vetrf.ru/schema/platform/services/2.0-last/ams-mercury-vu.service_v2.0_production.wsdl
Описание типов заявок: включено в WSDL		 WSDL:
http://api.vetrf.ru/schema/platform/services/2.0-last/ams-mercury-vu.service_v2.0_pilot.wsdl
Описание типов заявок: включено в WSDL
v2.1 WSDL:
недоступно		 WSDL:
недоступно

Сервис интеграции с государственной информационной системой "Маркировка товаров" (ГИС МТ)

Версия Продуктивный контур Тестовый контур
v1.0 WSDL: недоступно
Описание типов заявок: недоступно
ServiceId: недоступно
URL точки доступа: недоступно 		WSDL: https://api.vetrf.ru/schema/platform/crptgw/v1.0.0-crpt-latest/ams-crpt-gateway.service_v1.0_pilot.wsdl
Описание типов заявок: включено в WSDL
ServiceId: crpt-gateway.service
URL точки доступа: https://api2.vetrf.ru:8002/platform/services/2.0/ApplicationManagementService

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

Это группа сервисов предназначена для работы со справочниками и реестрами, использующимися в Ветис.

Подробно форматы запросов для обращения к справочникам и реестрам Ветис описаны в статье Подсистема работы со справочниками и реестрами в Ветис.API.

  • Цербер (EnterpriseService) - сервис получения реестра хозяйствующих субъектов и предприятий (PDF):
Версия Продуктивный контур Тестовый контур
v2.0 WSDL:
http://api.vetrf.ru/schema/platform/services/2.0-last/EnterpriseService_v2.0_production.wsdl
URL точки доступа:
https://api.vetrf.ru/platform/services/2.0/EnterpriseService 		WSDL:
http://api.vetrf.ru/schema/platform/services/2.0-last/EnterpriseService_v2.0_pilot.wsdl
URL точки доступа:
https://api2.vetrf.ru:8002/platform/services/2.0/EnterpriseService
v2.1 WSDL:
http://api.vetrf.ru/schema/platform/services/2.1-RC-last/EnterpriseService_v2.1_production.wsdl
URL точки доступа:
https://api.vetrf.ru/platform/services/2.1/EnterpriseService 		WSDL:
http://api.vetrf.ru/schema/platform/services/2.1-RC-last/EnterpriseService_v2.1_pilot.wsdl
URL точки доступа:
https://api2.vetrf.ru:8002/platform/services/2.1/EnterpriseService
  • Икар (IkarService) - сервис получения адресной справочной информации (PDF):
Версия Продуктивный контур Тестовый контур
v2.0 WSDL:
http://api.vetrf.ru/schema/platform/services/2.0-last/IkarService_v2.0_production.wsdl
URL точки доступа:
https://api.vetrf.ru/platform/services/2.0/IkarService 		WSDL:
http://api.vetrf.ru/schema/platform/services/2.0-last/IkarService_v2.0_production.wsdl
URL точки доступа:
https://api.vetrf.ru/platform/services/2.0/IkarService
v2.1 WSDL:
http://api.vetrf.ru/schema/platform/services/2.1-RC-last/IkarService_v2.1_production.wsdl
URL точки доступа:
https://api.vetrf.ru/platform/services/2.1/IkarService 		WSDL:
http://api.vetrf.ru/schema/platform/services/2.1-RC-last/IkarService_v2.1_production.wsdl
URL точки доступа:
https://api.vetrf.ru/platform/services/2.1/IkarService
  • DictionaryService - Сервис получения справочной информации (PDF):
Версия Продуктивный контур Тестовый контур
v2.0 WSDL:
http://api.vetrf.ru/schema/platform/services/2.0-last/DictionaryService_v2.0_production.wsdl
URL точки доступа:
https://api.vetrf.ru/platform/services/2.0/DictionaryService 		WSDL:
http://api.vetrf.ru/schema/platform/services/2.0-last/DictionaryService_v2.0_pilot.wsdl
URL точки доступа:
https://api2.vetrf.ru:8002/platform/services/2.0/DictionaryService
v2.1 WSDL:
http://api.vetrf.ru/schema/platform/services/2.1-RC-last/DictionaryService_v2.1_production.wsdl
URL точки доступа:
https://api.vetrf.ru/platform/services/2.1/DictionaryService 		WSDL:
http:// http://api.vetrf.ru/schema/platform/services/2.1-RC-last/DictionaryService_v2.1_pilot.wsdl
URL точки доступа:
https://api2.vetrf.ru:8002/platform/services/2.1/DictionaryService
  • ProductService - Сервис получения реестра категорий продукции (PDF):
Версия Продуктивный контур Тестовый контур
v2.0 WSDL:
http://api.vetrf.ru/schema/platform/services/2.0-last/ProductService_v2.0_production.wsdl
URL точки доступа:
https://api.vetrf.ru/platform/services/2.0/ProductService 		WSDL:
http://api.vetrf.ru/schema/platform/services/2.0-last/ProductService_v2.0_pilot.wsdl
URL точки доступа:
https://api2.vetrf.ru:8002/platform/services/2.0/ProductService
v2.1 WSDL:
http://api.vetrf.ru/schema/platform/services/2.1-RC-last/ProductService_v2.1_production.wsdl
URL точки доступа:
https://api.vetrf.ru/platform/services/2.1/ProductService 		WSDL:
http:// http://api.vetrf.ru/schema/platform/services/2.1-RC-last/ProductService_v2.1_pilot.wsdl
URL точки доступа:
https://api2.vetrf.ru:8002/platform/services/2.1/ProductService
  • RegionalizationService - Сервис проверки благополучия регионов и получения правил регионализации:
Версия Продуктивный контур Тестовый контур
v2.0 WSDL:
http://api.vetrf.ru/schema/platform/services/2.0-last/RegionalizationService_v2.0_production.wsdl
URL точки доступа:
https://api.vetrf.ru/platform/services/2.0/RegionalizationService 		WSDL:
http://api.vetrf.ru/schema/platform/services/2.0-last/RegionalizationService_v2.0_pilot.wsdl
URL точки доступа:
https://api2.vetrf.ru:8002/platform/services/2.0/RegionalizationService
v2.1 WSDL:
http://api.vetrf.ru/schema/platform/services/2.1-RC-last/RegionalizationService_v2.1_production.wsdl
URL точки доступа:
https://api.vetrf.ru/platform/services/2.1/RegionalizationService 		WSDL:
http://api.vetrf.ru/schema/platform/services/2.1-RC-last/RegionalizationService_v2.1_pilot.wsdl
URL точки доступа:
https://api2.vetrf.ru:8002/platform/services/2.1/RegionalizationService

Ветис.API 2.1

Продуктивный контур

Зависимости

Тестовый контур

Зависимости

Ветис.API 2.0

Продуктивный контур

Зависимости

Тестовый контур

Зависимости

Изменения в XSD-схемах для версии 2.1 по сравнению с версией 2.0

  • В перечислимый тип DocumentType добавлены новые типы документов.
  • Добавлен элемент registryStatus в тип Enterprise.
  • Добавлен тип EnterpriseStatus.
  • Добавлены поля фильтрации для операции getVetDocumentList: issueDateInterval, consignor, referencedDocument.
  • Добавлено поле фильтрации для операции getStockEntryList: searchPattern/receiptDateInterval.
  • Добавлены поля фильтрации для операции getVetDocumentChangesList: vetDocumentType, vetDocumentStatus.
  • Добавлены поля фильтрации для метода getProductItemList сервиса ProductService: producer, globalID.
  • Добавлены методы getLocalityChangesListRequest, getStreetChangesListRequest сервиса IkarService.
  • Добавлен элемент batch/applicableClassifications - дополнительные характеристики партии, включающее в себя элемент nonFoodSource - вид проиcхождения для непищевой продукции, технического сырья, кормов и кормовых добавок.
  • Добавлены новые типы транспорта (речной и перегон).

Предоставление доступа

Информация
 Примечание.
О рассмотрении обращений в службе технической поддержки по вопросам электронной сертификации - http://vetrf.ru/vetrf/news/26826.html


Доступ к ВетИС.API предоставляется в два этапа:

Первый этап — предоставление доступа к тестовой версии ВетИС.API для разработки и отладки;
Второй этап — предоставление доступа к продуктивной версии ВетИС.API.

Процедура предоставления доступа к ВетИС следующая:

1. Доступ к тестовой версии ВетИС.API для разработки и отладки клиентских модулей предоставляется по заявкам хозяйствующих субъектов и органов государственной власти субъектов Российской Федерации в сфере ветеринарии.
1.1. Заявка к тестовой версии подается через публичную электронную форму, доступную по адресу: https://t2-aplms.vetrf.ru/pub/.
Сведения, которые потребуются для оформления электронной заявки:
  • ИНН хозяйствующего субъекта, ответственного за формирование запросов к ВетИС.API (как правило, это собственник продукции, осуществляющий ветеринарную сертификацию).
  • Контакты лиц, ответственных за технические и организационные вопросы (ФИО, место работы, адрес электронной почты, телефон).
  • Название и вендор подключаемого клиентского интеграционного компонента, осуществляющей запросы к ВетИС.API.
1.2. К электронной заявке необходимо прикрепить скан заявления, оформленного на бланке организации за подписью руководителя (или уполномоченного им лица) и печатью организации по шаблону.
1.3. Регистрация производится должностными лицами ФГБУ «ВНИИЗЖ» в срок не более 5 рабочих дней после получения заявления.
1.4. После регистрации организации или учреждению предоставляются:
  • Реквизиты доступа к тестовой версии ВетИС.API (реквизиты доступа направляются на адрес электронной почты контактного лица).
  • Реквизиты доступа к веб-интерфейсу тестовой версии компонента Меркурий.ХС и ВетИС.Паспорт.
1.5. По окончании разработки и тестирования клиентского модуля организация или учреждение самостоятельно определяет свою готовность к переходу к продуктивной версии ВетИС.API. Готовность определяется с учетом следующих критериев:
  • Операции оформления ВСД и другие операции, реализованные из информационной системы организации или учреждения, не нарушают внутренние бизнес-процессы и не приводят к задержке производственных или логистических операций.
  • Все необходимые для организации или учреждения операции протестированы и апробированы в достаточной мере: оформление ВСД из информационной системы осуществлялось в течение периода не менее 10 рабочих дней в режиме реального производственного процесса.
  • В период апробации в режиме реального производственного процесса количество запросов с ошибками с кодом MERC не должно превышать 10% от общего количества запросов этого типа в сутки. Ошибки с кодом APL и APLM отсутствуют в период апробации.
Обратите внимание
 Обратите внимание!
Доступ к продуктивной версии ВетИС.API предоставляется только после того, как клиент завершил разработку и отладку в тестовой версии шлюза, и только в том случае, если сторонняя информационная система и разработанный для ее интеграции с компонентом «Меркурий» шлюз соответствуют требованиям:
  • Сторонняя информационная система должна обеспечивать отсутствие технической возможности внесения изменений в сертификат, оформление которого завершено, если такой сертификат хранится и на удаленных рабочих станциях сторонней информационной системы.


2. Доступ к продуктивной версии ВетИС.API для осуществления электронной ветеринарной сертификации предоставляется по заявкам хозяйствующих субъектов и органов государственной власти субъектов Российской Федерации в сфере ветеринарии при наличии обоснованной уверенности хозяйствующего субъекта в готовности использовать продуктивную версию ВетИС.API, подтверждая это при подаче заявления.
2.1. Заявка подается через публичную электронную форму, доступную по адресу: https://aplms.vetrf.ru/pub/.
2.2. К электронной заявке необходимо прикрепить скан заявления, оформленного на бланке организации за подписью руководителя (или уполномоченного им лица) и печатью организации по шаблону. Также вы можете подать заявку на получение доступа с помощью электронной подписи по инструкции.
2.3. Регистрация производится должностными лицами ФГБУ «ВНИИЗЖ» в срок не более 5 рабочих дней после получения заявки.
2.4. После регистрации организации или учреждению предоставляются:
  • Реквизиты доступа к продуктивной версии ВетИС.API (реквизиты доступа направляются на адрес указанной электронной почты контактного лица).
  • Возможность использовать продуктивную версию ВетИС.API в соответствии с назначенной ролью и указанной зоной обслуживания.
  • Доступ к тестовой версии ВетИС.API сохраняется.
  • Доступ к веб-интерфейсу ВетИС для рабочего сервера необходимо получить по отдельной заявке. Инструкция и шаблон заявки доступны по ссылке.
2.5. Регистрация может быть аннулирована в следующих случаях:
  • Если общее количество любых ошибок при выполнении бизнес-операций в продуктивной версии ВетИС.API превысило 10% от общего количества запросов этого типа за сутки. В этом случае организации или учреждению, ответственному за оформление запросов к шлюзу, выносится предупреждение. Если ошибки не устранены в течение 5 рабочих дней, производится отключение программной системы от продуктивной версии ВетИС.API на срок не менее 1 месяца и до устранения ошибок. В этот период учреждению или организации доступна только тестовая версия ВетИС.API.
2.6. Для восстановления доступа к продуктивной версии ВетИС.API необходимо отправить соответствующую заявку.

С чего начать

ECR-Russia и лично координатор данной организации по вопросам, связанным с оформлением электронных ВСД, Юрий Кумпан, подготовил документ, который содержит практические шаги по реализации интеграционного проекта учетной системы предприятия с ФГИС "Меркурий", называется он «Первые шаги в проектах интеграции с ФГИС Меркурий».

Обновление компонента

Перечень обновлений компонента: 2023 год | 2022 год | 2021 год | 2020 год | 2019 год | 2018 год | 2016 год | 2015 год | 2014 год

Планируемые функции

Предварительный перечень функций, запланированных на второе поколение компонента (версии 3.x шлюза)

С предложениями по развитию Ветис.API обращайтесь по электронной почте на адрес api@vetrf.ru или на специализированный форум системы.

Предварительный список изменений для версии 6.7 и версии 2.1 интеграционного шлюза

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

Сопровождение и поддержка

По техническим вопросам, связанным с использованием Ветис.API, обращайтесь по электронной почте на адрес api@vetrf.ru.

При наличии технической проблемы опишите в письме ее суть, приложите примеры SOAP-запросов и ответов. Свои предложения и пожелания по разработке Ветис.API вы можете также направлять по данному адресу.

Ссылки

См. также

Вернуться к началу ↑

Источник — http://help.vetrf.ru/index.php?title=Компонент_Ветис.API&oldid=38853