API REST publique

API REST publique de Kilo IoT Server — surface d’intégration principale sur HTTPS/JSON avec X-API-Key et X-Organization-Id.

L’API REST est le principal moyen d’intégrer Kilo IoT Server à des systèmes externes via HTTPS standard. N’importe quel langage ou outil capable d’effectuer une requête HTTP authentifiée peut l’utiliser — services back-end, pipelines de données, tâches de reporting et outils d’exploitation.

Utilisez le référence de l'API pour obtenir la liste complète des points de terminaison, des paramètres de requête, des schémas de réponse et des portées requises.

Point de terminaison de base et authentification

Les requêtes sont envoyées vers le point de terminaison de production sécurisé et comportent deux en-têtes :

• X-API-Key — une clé à portée créée dans Paramètres → Clés API.

• X-Organization-Id — l’organisation dans laquelle la requête s’exécute ; elle doit correspondre à l’organisation de la clé. Certaines opérations acceptent également l’organisation comme organizationId paramètre de requête au lieu de l’en-tête.

Tout le trafic passe par TLS. Traitez la clé comme un identifiant d’accès — voir Authentification et clés API.

Ce que l’API peut faire

REST est la surface principale et la plus large. Sous réserve des portées accordées à la clé, les intégrations peuvent fonctionner sur toute la plateforme — par exemple : lire le profil du compte/utilisateur ; lister et gérer les appareils et leur configuration physique de l’appareil (l’identifiant du périphérique client, la connexion à laquelle il est associé et les paramètres spécifiques à la connexion), leurs capteurs et les mappages de capteurs, ainsi que les modèles de capteurs ; lire les données des capteurs historique et dernières valeurs connues valeurs ; lire les définitions des connecteurs et gérer les connexions ; lire et gérer les tableaux de bord et les widgets ; lire les données d’organisation, d’adhésion et d’abonnement ; lire et gérer les définitions des règles, ainsi que leurs versions et leurs builds; et définir et envoyer des commandes d’appareil pour contrôler le matériel.

Pour les intégrations typées de service à service ou sur site, voir API gRPC.

Flux de travail

1. Créez une clé à portée dans Paramètres → Clés API et stockez-la en lieu sûr.

2. Trouvez l’opération dont vous avez besoin dans la référence de l’API.

3. Appelez-la avec X-API-Key et X-Organization-Id.

4. Gérez les codes d’état HTTP standard et les réponses JSON.

Un appel authentifié minimal se trouve dans Exemples.

Voir aussi

• API gRPC — lorsque des clients typés ou des appels de service à service conviennent mieux.

• Authentification et clés API

• Clés API — créer et gérer des clés.