Interface d'accès unifiée

API REST universelle

Le système met en œuvre une API REST universelle qui assure une interaction cohérente entre différents systèmes, applications et appareils. Elle fait abstraction des détails de mise en œuvre et offre un moyen normalisé d’accéder aux données et aux fonctions du système.

Le service d’API REST présente les caractéristiques de traitement des données suivantes :

• Uniformité : toutes les requêtes et toutes les réponses suivent le même format.
• Évolutivité : prise en charge d’un grand nombre d’appareils et d’utilisateurs.
• Sécurité : assure l’authentification, l’autorisation et le chiffrement des données.
• Documentation : dispose d’une documentation claire à destination des développeurs.

Le service simplifie considérablement l’exploitation ultérieure des données :

• Intégration simplifiée : différents systèmes et appareils peuvent interagir via une interface unique.
• Abstraction matérielle : les applications ne dépendent pas d’appareils ou de protocoles particuliers.
• Gestion centralisée : toutes les requêtes de données passent par un point d’entrée unique.
• Souplesse : il est facile d’ajouter de nouvelles fonctionnalités ou de modifier celles qui existent.

Exemple de requête d’API REST universelle

Requête de données :

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

Réponse :

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

Avantages de l’API REST universelle

Le service d’API REST est un outil puissant qui crée une interface d’accès aux données unifiée.

Il permet de :

• Faire abstraction des appareils et des technologies spécifiques.
• Garantir la cohérence et la simplicité d’utilisation.
• Simplifier l’intégration de nouveaux systèmes et appareils.

Langage de requête

S’appuyant sur cette interface d’accès aux données unifiée, le système utilise un langage de requête afin que les utilisateurs et les applications puissent interagir avec la base de données pour récupérer, modifier ou gérer des informations. Un langage de requête universel apporte cohérence, simplicité d’utilisation et de puissantes capacités de manipulation des données.

Le langage de requête offre les capacités suivantes :

• Manipulation des données simplifiée : les utilisateurs peuvent récupérer des données sans écrire de code complexe.
• Normalisation : un langage unique pour toutes les opérations sur les données.
• Souplesse : la possibilité d’exécuter aussi bien des requêtes simples que complexes.
• Intégration : s’intègre facilement à divers systèmes et applications.

Exemples de langages de requête utilisés dans le système

SQL (Structured Query Language)

Le SGBD PostgreSQL utilise le langage de requête SQL pour l’exploitation des données. Il prend en charge les opérations de base de manipulation des données.

Exemple de requête SQL pour la récupération de données :

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

Interface REST paramétrée

L’API REST universelle met en œuvre une interface REST paramétrée dans le cadre de son interaction avec les données. Cela permet à l’API d’utiliser des paramètres de requête pour filtrer les données.

Par exemple :

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

Active Record Query Interface

Le framework Ruby on Rails met en œuvre Active Record (Active Record Query Interface), qui permet d’interroger les bases de données sans utiliser SQL.

Voici un exemple de requête Active Record pour récupérer des données :

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