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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Структура

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

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

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

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

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

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

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

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

Версия Продуктивный контур Тестовый контур
v1.4 WSDL:
http://api.vetrf.ru/schema/platform/services/ApplicationManagementService_v1.4_production.wsdl
Описание типов заявок:
http://api.vetrf.ru/schema/platform/mercury/g2b/applications_v1.4.xsd
WSDL:
http://api.vetrf.ru/schema/platform/services/ApplicationManagementService_v1.4_pilot.wsdl
Описание типов заявок:
http://api.vetrf.ru/schema/platform/mercury/g2b/applications_v1.4.xsd
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.
  • Запрос на URL 2.0 с serviceId 2.1 будет обработан как запрос версии 2.1.
  • Запрос на URL 2.1 с serviceId 2.0 будет обработан как запрос версии 2.0.
  • Рекомендация: отправлять запросы на URL с serviceId согласно используемой версии.

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

Версия Продуктивный контур Тестовый контур
v1.4 WSDL:
http://api.vetrf.ru/schema/platform/services/ApplicationManagementService_v1.4_production.wsdl
Описание типов заявок:
http://api.vetrf.ru/schema/platform/mercury/vu/applications_v1.4.xsd
WSDL:
http://api.vetrf.ru/schema/platform/services/ApplicationManagementService_v1.4_pilot.wsdl
Описание типов заявок:
http://api.vetrf.ru/schema/platform/mercury/vu/applications_v1.4.xsd
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:
недоступно

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

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

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

  • Цербер (EnterpriseService) - сервис получения реестра хозяйствующих субъектов и предприятий (PDF):
Версия Продуктивный контур Тестовый контур
v1.4 WSDL:
http://api.vetrf.ru/schema/platform/cerberus/services/EnterpriseService_v1.3_production.wsdl
URL точки доступа:
https://api.vetrf.ru/platform/cerberus/services/EnterpriseService
WSDL:
http://api.vetrf.ru/schema/platform/cerberus/services/EnterpriseService_v1.4_pilot.wsdl
URL точки доступа:
https://api2.vetrf.ru:8002/platform/cerberus/services/EnterpriseService
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):
Версия Продуктивный контур Тестовый контур
v1.4 WSDL:
http://api.vetrf.ru/schema/platform/ikar/services/IkarService_v1.3_production.wsdl
URL точки доступа:
https://api.vetrf.ru/platform/ikar/services/IkarService
WSDL:
http://api.vetrf.ru/schema/platform/ikar/services/IkarService_v1.4_pilot.wsdl
URL точки доступа:
https://api2.vetrf.ru:8002/platform/ikar/services/IkarService
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_pilot.wsdl
URL точки доступа:
https://api2.vetrf.ru:8002/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_pilot.wsdl
URL точки доступа:
https://api2.vetrf.ru:8002/platform/services/2.1/IkarService
  • DictionaryService - Сервис получения справочной информации (PDF):
Версия Продуктивный контур Тестовый контур
v1.4 WSDL:
http://api.vetrf.ru/schema/platform/services/DictionaryService_v1.3_production.wsdl
URL точки доступа:
https://api.vetrf.ru/platform/dictionary/services/DictionaryService
WSDL:
http://api.vetrf.ru/schema/platform/services/DictionaryService_v1.4_pilot.wsdl
URL точки доступа:
https://api2.vetrf.ru:8002/platform/dictionary/services/DictionaryService
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):
Версия Продуктивный контур Тестовый контур
v1.4 WSDL:
http://api.vetrf.ru/schema/platform/services/ProductService_v1.3_production.wsdl
URL точки доступа:
https://api.vetrf.ru/platform/Product/services/productService
WSDL:
http://api.vetrf.ru/schema/platform/services/ProductService_v1.4_pilot.wsdl
URL точки доступа:
https://api2.vetrf.ru:8002/platform/product/services/ProductService
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 - Сервис проверки благополучия регионов и получения правил регионализации:
Версия Продуктивный контур Тестовый контур
v1.4 недоступно недоступно
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хождения для непищевой продукции, технического сырья, кормов и кормовых добавок.
  • Добавлен необязательный атрибут qualifier в тип StockEntry.
  • Добавлена операция пакетного гашения ProcessIncomingDeliveryRequest (запланировано к реализации до 01.07.2018).
  • Добавлены новые типы транспорта (речной и перегон).

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


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

  1. Доступ к Ветис.API предоставляется в 2 этапа: первый этап – подача заявки на предоставление доступа к тестовой версии (Пример заявки на подключение к тестовой версии Ветис.API) Ветис.API для разработки и отладки, второй этап – подача заявки на предоставление доступа к продуктивной версии Ветис.API.
  2. Доступ к тестовой версии Ветис.API для разработки и отладки клиентских модулей предоставляется по заявкам хозяйствующих субъектов и органов государственной власти субъектов Российской Федерации в сфере ветеринарии.
  3. Заявка к тестовой версии подается при помощи публичной электронной формы, доступной по адресу https://t2-aplms.vetrf.ru/pub/.
  4. Сведения, которые потребуются для оформления электронной заявки:
    1. ИНН хозяйствующего субъекта, ответственного за формирование запросов к ВетИС.API (как правило, это собственник продукции, осуществляющий ветеринарную сертификацию).
    2. Контакты лиц, ответственных за технические и организационные вопросы (ФИО, место работы, адрес электронной почты, телефон).
    3. Название и вендор подключаемого клиентского интеграционного компонента, осуществляющей запросы к ВетИС.API.
  5. К электронной заявке необходимо прикрепить скан заявления, оформленного на бланке организации с подписью руководителя (или уполномоченного им лица) и печатью организации в соответствии с шаблоном.
  6. Регистрация производится должностными лицами ФГБУ "ВНИИЗЖ" в срок не более 5 рабочих дней после получения заявки.
  7. После регистрации организации или учреждению предоставляются:
    1. Реквизиты доступа к тестовой версии Ветис.API (реквизиты доступа направляются на адрес электронной почты контактного лица).
    2. Реквизиты доступа к веб-интерфейсу тестовой версии систем Меркурий.ХС и Ветис.Паспорт.
  8. По окончании разработки и тестирования клиентского модуля организация или учреждение самостоятельно определяет свою готовность к переходу к продуктивной версии Ветис.API. Готовность определяется с учетом следующих критериев:
    1. Операции оформления ВСД и другие операции, реализованные из информационной системы организации или учреждения, не нарушают внутренние бизнес-процессы и не приводят к задержке производственных или логистических операций.
    2. Все необходимые для организации или учреждения операции протестированы и апробированы в достаточной мере: оформление ВСД из информационной системы осуществлялось в течение периода не менее 10 рабочих дней в режиме реального производственного процесса.
    3. В период апробации в режиме реального производственного процесса количество запросов с ошибками с кодом MERC не должно превышать 10% от общего количества запросов этого типа в сутки. Ошибки с кодом APL и APLM отсутствуют в период апробации.
  9. Доступ к продуктивной версии предоставляется только после того, как клиент завершил разработку и отладку в тестовой версии шлюза и только в том случае, если сторонняя информационная система и разработанный для ее интеграции с ФГИС Меркурий шлюз соответствуют следующим требованиям:
    1. Сторонняя информационная система должна обеспечивать отсутствие технической возможности внесения изменений в сертификат, оформление которого завершено, если такой сертификат хранится и на удаленных рабочих станциях сторонней информационной системы.
  10. При наличии обоснованной уверенности в готовности использовать продуктивную версию Ветис.API (Пример заявки на подключение к продуктивной версии Ветис.API) организация или учреждение сообщает об этом путем направления заявки на доступ к продуктивной версии Ветис.API, содержащей сведения, указанные в пункте 4. Заявка подается при помощи публичной электронной формы, доступной по адресу https://aplms.vetrf.ru/pub/ (с 04.06.18, заявки, поданные до 04.06.18 будут обработаны по ранее утвержденному порядку).
  11. Регистрация производится должностными лицами ФГБУ "ВНИИЗЖ" в срок не более 5 рабочих дней после получения заявки.
  12. После регистрации организации или учреждению предоставляются:
    1. Реквизиты доступа к продуктивной версии Ветис.API (реквизиты доступа направляются на адрес указанной электронной почты контактного лица).
    2. Возможность использовать продуктивную версию Ветис.API в соответствии с назначенной ролью и указанной "Зоной обслуживания".
    3. Доступ к тестовой версии Ветис.API сохраняется.
    4. Доступ в веб-интерфейс для рабочего сервера необходимо получить по отдельной заявке. Инструкцию и шаблон заявки вы можете посмотреть здесь
  13. Регистрация может быть аннулирована в следующих случаях.
    1. Если общее количество любых ошибок при выполнении бизнес-операций в продуктивной версии Ветис.API превысило 10% от общего количества запросов этого типа за сутки. В этом случае организации или учреждению, ответственному за оформление запросов к шлюзу, выносится предупреждение. Если ошибки не устранены в течение 5 рабочих дней, производится отключение программной системы от продуктивной версии Ветис.API на срок не менее 1 месяца и до устранения ошибок. В этот период учреждению или организации доступна только тестовая версия Ветис.API.
  14. Для восстановления доступа к продуктивной версии Ветис.API необходимо отправить соответствующую заявку.

С чего начать

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

Обновление системы

Перечень обновлений системы:

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

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

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

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

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

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

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

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

Ссылки

См. также

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