Единый интерфейс доступа

Универсальный REST API

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

Сервис REST API обладает следующими характеристиками работы с данными:

• Единообразие: все запросы и ответы имеют один и тот же формат.
• Масштабируемость: поддерживается большое количество устройств и пользователей.
• Безопасность: обеспечиваются аутентификация, авторизация и шифрование данных.
• Документированность: имеется понятная документация для разработчиков.

Сервис значительно упрощает дальнейшую работу с данными:

• Упрощённая интеграция: различные системы и устройства могут взаимодействовать через единый интерфейс.
• Абстрагирование от оборудования: приложения не зависят от конкретных устройств или протоколов.
• Централизованное управление: все запросы данных проходят через единую точку входа.
• Гибкость: новые функции легко добавлять, а существующие — изменять.

Пример запроса к универсальному REST API

Запрос данных:

GET /api/v1/channel_data?equipment_id=1&archive_type=daily&channel_id=3

Ответ:

[
  {
    "id": 123,
    "equipment_id": 1,
    "seance_id": 2,
    "channel_id": 3,
    "archive_type_id": 4,
    "value": 42.5,
    "event_time": 1739950861
  }
]

Преимущества универсального REST API

Сервис REST API — это мощный инструмент, формирующий единый интерфейс доступа к данным.

Он позволяет:

• Абстрагироваться от конкретных устройств и технологий.
• Обеспечить согласованность и удобство использования.
• Упростить интеграцию новых систем и устройств.

Язык запросов

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

Язык запросов предоставляет следующие возможности:

• Упрощённая работа с данными: пользователи могут получать данные, не прибегая к написанию сложного кода.
• Стандартизация: единый язык для всех операций с данными.
• Гибкость: возможность выполнять как простые, так и сложные запросы.
• Интеграция: легко интегрируется с различными системами и приложениями.

Примеры языков запросов, используемых в системе

SQL (Structured Query Language)

СУБД PostgreSQL использует для работы с данными язык запросов SQL. Он поддерживает основные операции по работе с данными.

Пример SQL-запроса для получения данных:

SELECT id, channel_id, value
FROM channel_data
WHERE equipment_id = 1 AND archive_type_id = 4;

REST-интерфейс с параметрами

Универсальный REST API реализует REST-интерфейс с параметрами как часть своего взаимодействия с данными. Это позволяет API использовать параметры запроса для фильтрации данных.

Например:

GET /api/v1/channel_data?equipment_id=1&channel_id=101

Интерфейс запросов Active Record

Фреймворк Ruby on Rails реализует Active Record (интерфейс запросов Active Record), который позволяет обращаться к базам данных без использования SQL.

Ниже приведён пример запроса Active Record для получения данных:

ChannelDatum.where(equipment_id: 1, archive_type_id: 4)