Методические рекомендации

Содержание

• 1. Введение
  • 1.1. Общие Сведения
    • 1.1.1. Номер версии документа
    • 1.1.2. Нормативно-правовые основания
  • 1.2. Виды информационного обмена с использованием СМЭВ
    • 1.2.1. Классификация регламентированных SQL-запросов
  • 1.3. Участники информационного обмена с использованием ПОДД СМЭВ
  • 1.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. Диаграмма последовательности информационного обмена
    • 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. Регистрация в ПОДД REST-сервиса ИС Ответчика и инициализация обмена
        • 1.4.3.4.2. Информационный обмен для механизма без возможности отправки большого запроса
        • 1.4.3.4.3. Информационный обмен для механизма с возможностью отправки большого запроса
  • 1.5. Метаданные ПОДД СМЭВ
    • 1.5.1. Поддерживаемые форматы
    • 1.5.2. Модель данных Витрины Поставщика данных
    • 1.5.3. Подписки Потребителей данных ПОДД СМЭВ на регламентированный запрос типа «Рассылка»
    • 1.5.4. Определения Регламентированных SQL-запросов
    • 1.5.5. REST-сервисы ИС Ответчиков
      • 1.5.5.1. Спецификация OpenAPI, описывающая REST-сервис с функцией возврата запрошенных данных от ИС Ответчика
    • 1.5.6. Полномочия Потребителя данных ПОДД СМЭВ на доступ к данным
      • 1.5.6.1. Полномочия на выполнение произвольных SQL-запросов
      • 1.5.6.2. Полномочия на выполнение Регламентированных SQL-запросов
      • 1.5.6.3. Полномочия на выполнение запросов к REST-сервису ИС Ответчика
      • 1.5.6.4. Полномочия на Рассылку
  • 1.6. Типы данных ПОДД СМЭВ
• 2. Описание подключения к ПОДД СМЭВ
  • 2.1. Протокол ПОДД СМЭВ
  • 2.2. Подключение участников взаимодействия с использованием ПОДД СМЭВ
  • 2.3. Протокол взаимодействия Агента ПОДД СМЭВ и Витрины Поставщика данных
    • 2.3.1. Перечень заголовков сообщений в Apache Kafka
    • 2.3.2. Перечень топиков брокера сообщений Apache Kafka
    • 2.3.3. Настройка Агента ПОДД для работы с несколькими Витринами данных
      • 2.3.3.1. Регистрация на основе конфигурационного файла
      • 2.3.3.2. Регистрация на основе сообщений Витрин
    • 2.3.4. Последовательность исполнения SQL-запроса в контуре Поставщика данных
    • 2.3.5. Структуры сообщений для взаимодействия с Поставщиком
    • 2.3.6. Примеры реализации взаимодействия с Агентом ПОДД СМЭВ с использованием брокера сообщений Apache Kafka
      • 2.3.6.1. Получение запроса от Агента ПОДД СМЭВ
      • 2.3.6.2. Передача результата Агенту ПОДД СМЭВ
  • 2.4. Протокол взаимодействия Агента ПОДД СМЭВ и ИС Потребителя данных
    • 2.4.1. REST-интерфейс Агента ПОДД для SQL-запросов
      • 2.4.1.1. Выполнение SQL-запросов (синхронный режим)
        • 2.4.1.1.1. HTTP-запрос при подключении к Pulsar
        • 2.4.1.1.2. HTTP-запрос при подключении к брокеру
        • 2.4.1.1.3. Ответ на HTTP-запрос
      • 2.4.1.2. Выполнение SQL-запросов (асинхронный режим)
        • 2.4.1.2.1. HTTP-запрос передачи SQL-запроса в Агент ПОДД (метод POST)
          • 2.4.1.2.1.1. HTTP-запрос при подключении к Pulsar
          • 2.4.1.2.1.2. HTTP-запрос при подключении к брокеру
          • 2.4.1.2.1.3. Ответ на HTTP-запрос
        • 2.4.1.2.2. HTTP-запрос получения результата, ранее переданного в Агент ПОДД СМЭВ асинхронного SQL-запроса (метод GET)
          • 2.4.1.2.2.1. HTTP-запрос при подключении к Pulsar
          • 2.4.1.2.2.2. HTTP-запрос при подключении к брокеру
          • 2.4.1.2.2.3. Ответ на HTTP-запрос
      • 2.4.1.3. Выполнение запроса с табличным параметром
        • 2.4.1.3.1. HTTP-запрос с табличным параметром при подключении к Pulsar
        • 2.4.1.3.2. HTTP-запрос с табличным параметром при подключении к брокеру
      • 2.4.1.4. Выполнение запроса на получение BLOB по ссылке
        • 2.4.1.4.1. HTTP-запрос при подключении к Pulsar
        • 2.4.1.4.2. HTTP-запрос при подключении к брокеру
        • 2.4.1.4.3. Ответ на HTTP-запрос
    • 2.4.2. REST-интерфейс Агента ПОДД для запросов к REST-сервису ИС Ответчика
      • 2.4.2.1. HTTP-запрос
      • 2.4.2.2. Ответ на HTTP-запрос
    • 2.4.3. JDBC-интерфейс Агента ПОДД СМЭВ для SQL-запросов
      • 2.4.3.1. Пример использования JDBC-драйвера в «Kotlin»
      • 2.4.3.2. Коды возврата
  • 2.5. Протокол взаимодействия Агента ПОДД СМЭВ и Хранилища данных по подписке Потребителя данных
    • 2.5.1. Перечень топиков брокера сообщений Apache Kafka
    • 2.5.2. Структуры сообщений для взаимодействия с Потребителем данных
  • 2.6. Протокол взаимодействия Агента ПОДД СМЭВ и ИС Ответчика
• 3. Использование ПОДД СМЭВ
  • 3.1. SQL-синтаксис
    • 3.1.1. Указание в запросе версии Витрины
      • 3.1.1.1. Запрос с использованием REST-интерфейса
• 4. Термины и сокращения
• 5. История изменений
• 6. Приложение 1 Пример проекта для реализации взаимодействия с Агентом ПОДД
• 7. Приложение 2 Структуры сообщений для взаимодействия с Поставщиком
• 8. Приложение 3 Структуры сообщений для взаимодействия с Потребителем данных