Методические рекомендации по работе с СМЭВ4

Содержание

• 1. Введение
  • 1.1. Общие Сведения
    • 1.1.1. Нормативно-правовые основания
  • 1.2. Виды информационного обмена с использованием СМЭВ
    • 1.2.1. Классификация регламентированных SQL-запросов
  • 1.3. Участники информационного обмена с использованием СМЭВ4
  • 1.4. Информационный обмен участников взаимодействия с использованием СМЭВ4
    • 1.4.1. Обмен с использованием Регламентированных SQL-запросов
      • 1.4.1.1. Общее описание информационного обмена
      • 1.4.1.2. Требования к участникам взаимодействия
        • 1.4.1.2.1. Требования к Поставщикам данных
        • 1.4.1.2.2. Требования к Потребителям данных
      • 1.4.1.3. Взаимодействие участников обмена
      • 1.4.1.4. Информационный обмен с использованием SQL-РЗ
    • 1.4.2. Обмен с использованием Рассылок
      • 1.4.2.1. Общее описание информационного обмена
      • 1.4.2.2. Требования к участникам взаимодействия
        • 1.4.2.2.1. Требования к Поставщикам данных
        • 1.4.2.2.2. Требования к Потребителям данных
      • 1.4.2.3. Взаимодействия участников обмена
      • 1.4.2.4. Описание этапов
        • 1.4.2.4.1. Регистрация подписки
        • 1.4.2.4.2. Информационный обмен по Рассылке
        • 1.4.2.4.3. Удаление подписки
    • 1.4.3. Обмен с использованием запросов к REST-сервису ИС Ответчика
      • 1.4.3.1. Общее описание информационного обмена
      • 1.4.3.2. Требования к участникам взаимодействия
        • 1.4.3.2.1. Требования к Ответчикам
        • 1.4.3.2.2. Требования к Инициаторам запросов
      • 1.4.3.3. Взаимодействие участников обмена
      • 1.4.3.4. Описание этапов
        • 1.4.3.4.1. Регистрация в СМЭВ4 REST-сервиса ИС Ответчика
        • 1.4.3.4.2. Информационный обмен с использованием REST-РЗ
  • 1.5. Метаданные СМЭВ4
    • 1.5.1. Поддерживаемые форматы
    • 1.5.2. Модель данных Витрины Поставщика данных
    • 1.5.3. Профиль Витрины Поставщика данных
    • 1.5.4. Определения Регламентированных SQL-запросов
    • 1.5.5. Подписки Потребителей данных СМЭВ4 на регламентированный запрос типа «Рассылка»
    • 1.5.6. REST-сервисы ИС Ответчиков
    • 1.5.7. Права доступа Потребителя данных СМЭВ4 на доступ к данным
      • 1.5.7.1. Право доступа на выполнение произвольных SQL-запросов
      • 1.5.7.2. Право доступа на выполнение Регламентированных SQL-запросов
      • 1.5.7.3. Право доступа на выполнение запросов к REST-сервису ИС Ответчика
      • 1.5.7.4. Право доступа на Рассылку
      • 1.5.7.5. Право доступа на получение запросов и ответов из хранилища
  • 1.6. Типы данных СМЭВ4
• 2. Описание подключения к СМЭВ4
  • 2.1. Подключение участников взаимодействия с использованием СМЭВ4
  • 2.2. Протокол взаимодействия Агента СМЭВ4 и Витрины Поставщика данных
    • 2.2.1. Перечень топиков брокера сообщений Apache Kafka
  • 2.3. Протокол взаимодействия Агента СМЭВ4 и ИС Потребителя данных
    • 2.3.1. REST-интерфейс Агента СМЭВ4 для SQL-запросов
      • 2.3.1.1. Выполнение SQL-запросов (синхронный режим)
        • 2.3.1.1.1. HTTP-запрос на вызов Регламентированного SQL-запроса
        • 2.3.1.1.2. HTTP-запрос на вызов Регламентированного SQL-запроса (с возможностью использования надстроек)
        • 2.3.1.1.3. Ответ на HTTP-запрос
      • 2.3.1.2. Выполнение SQL-запросов (асинхронный режим)
        • 2.3.1.2.1. HTTP-запрос передачи SQL-запроса в Агент СМЭВ4 (метод POST)
          • 2.3.1.2.1.1. HTTP-запрос на вызов Регламентированного SQL-запроса
          • 2.3.1.2.1.2. HTTP-запрос на вызов Регламентированного SQL-запроса (с возможностью использования надстроек)
          • 2.3.1.2.1.3. Ответ на HTTP-запрос
        • 2.3.1.2.2. HTTP-запрос получения результата ранее переданного в Агент СМЭВ4 асинхронного SQL-запроса (метод GET)
          • 2.3.1.2.2.1. HTTP-запрос
          • 2.3.1.2.2.2. Ответ на HTTP-запрос
        • 2.3.1.2.3. HTTP-запрос на удаление результата выполнения ранее переданного в Агент СМЭВ4 асинхронного SQL-запроса (метод DELETE)
          • 2.3.1.2.3.1. HTTP-запрос
          • 2.3.1.2.3.2. Ответ на HTTP-запрос
      • 2.3.1.3. Выполнение запроса с табличным параметром
        • 2.3.1.3.1. HTTP-запрос на вызов запроса с табличным параметром
        • 2.3.1.3.2. HTTP-запрос с табличным параметром на вызов запроса с возможностью использования надстроек
      • 2.3.1.4. Выполнение запроса на получение BLOB по ссылке
        • 2.3.1.4.1. HTTP-запрос (вариант 1)
        • 2.3.1.4.2. HTTP-запрос (вариант 2)
        • 2.3.1.4.3. Ответ на HTTP-запрос
    • 2.3.2. REST-интерфейс Агента СМЭВ4 для запросов к REST-сервису ИС Ответчика
      • 2.3.2.1. HTTP-запрос
      • 2.3.2.2. Ответ на HTTP-запрос
    • 2.3.3. JDBC-интерфейс Агента СМЭВ4 для SQL-запросов
      • 2.3.3.1. Пример использования JDBC-драйвера в «Kotlin»
      • 2.3.3.2. Коды возврата
  • 2.4. Протокол взаимодействия Агента СМЭВ4 и Витрины Потребителя данных
    • 2.4.1. Перечень топиков брокера сообщений Apache Kafka
  • 2.5. Протокол взаимодействия Агента СМЭВ4 и ИС Ответчика
• 3. Использование СМЭВ4
  • 3.1. SQL-синтаксис
  • 3.2. Примеры запросов с использованием SQL-синтаксиса, поддерживаемого СМЭВ4
    • 3.2.1. Запрос с использованием табличных выражений
    • 3.2.2. Указание в запросе версии Витрины
    • 3.2.3. Запросы с использованием JOIN
  • 3.3. Выполнение регламентированных SQL-запросов
    • 3.3.1. Правила выполнения
    • 3.3.2. Примеры вызова и преобразования исходного запроса
    • 3.3.3. Выполнение запроса с системным параметром
    • 3.3.4. Выполнение запросов с использованием табличных параметров, передаваемых Потребителем данных для обогащения
      • 3.3.4.1. Запрос с использованием REST-интерфейса
      • 3.3.4.2. Запрос с использованием JDBC-интерфейса
    • 3.3.5. Получение двоичных объектов в результатах запроса
    • 3.3.6. Получение печатной формы в результатах запроса
    • 3.3.7. Выполнение запроса с полнотекстовым поиском
  • 3.4. Выполнение запросов к REST-сервису ИС Ответчика
  • 3.5. Сквозная идентификация запросов
  • 3.6. Лимитирование регламентированных запросов Потребителя к информационным ресурсам Поставщика
    • 3.6.1. Лимиты
    • 3.6.2. Условия для добавления лимитов
    • 3.6.3. Блокировки
    • 3.6.4. Управление лимитами и блокировками
    • 3.6.5. Алгоритм лимитирования
• 4. Термины и сокращения
• 5. Приложение А Перечень типовых ошибок и пути их решения
• 6. История изменений