Aperçu de l'API
La plateforme Mirox expose une API REST afin que vous puissiez intégrer les données de centrale, l'automatisation et le reporting dans vos propres systèmes et flux de travail. Tout ce que fait l'interface web repose sur les mêmes endpoints publics, vous pouvez donc piloter la plateforme par programmation.
Documentation interactive
La spécification complète de l'API est générée en direct depuis la plateforme en cours d'exécution et est disponible dans deux vues interactives :
- Swagger UI à l'adresse
/docs— une référence interactive avec un générateur de requêtes intégré pour essayer les appels directement dans le navigateur. - ReDoc à l'adresse
/redoc— la même spécification dans une mise en page optimisée pour la lecture et la navigation.
Les deux vues vous permettent d'explorer chaque endpoint disponible, ses paramètres, son corps de requête et son format de réponse. Elles constituent la référence faisant autorité et toujours à jour de ce que l'API peut faire.
Comment l'API est organisée
Les endpoints de l'API sont regroupés selon ce sur quoi ils agissent, et chaque chemin est versionné (par exemple /v1/...). Les domaines courants comprennent :
- Centrales, portefeuilles et composants — lire et gérer vos sites supervisés et leur structure.
- Métriques et export de données — récupérer les données de production et de capteurs au format CSV ou JSON, ou construire des métriques dérivées avec MiroxQL.
- Événements, tickets et rapports — récupérer les signaux détectés par la machine, le travail de suivi humain et les rapports générés.
- Organisation, coopérations et accès — gérer les membres, le partage et les jetons d'intégration.
L'accès à chaque endpoint est régi par votre rôle et vos autorisations. Un appel ne retourne que les centrales et les données que vous êtes en droit de voir, de sorte que l'API applique les mêmes règles d'accès que l'interface.
Tout n'est pas listé dans /docs
Quelques groupes de routes sont intentionnellement masqués de la spécification publiée ; ils n'apparaîtront donc pas dans /docs ni /redoc même s'ils fonctionnent :
- Endpoints d'administration — fonctions d'administration de la plateforme réservées au personnel Mirox.
- Routes d'affectation d'appareils (
/v1/device).
Si vous devez intégrer l'une de ces routes, contactez le support Mirox pour obtenir des conseils.
Accès programmatique aux données brutes
Pour les données de séries temporelles brutes et dérivées, utilisez MiroxQL ou l'API d'export de métriques. MiroxQL est le moyen pris en charge pour construire et interroger des métriques par programmation.
Pour commencer
Pour appeler l'API, vous vous authentifiez avec un jeton d'API rattaché à un groupe d'autorisations. Consultez le guide Jetons d'API pour savoir comment créer, restreindre et faire tourner les jetons, puis utilisez-les pour effectuer des requêtes.
Ouvrir dans Mirox
Créez et gérez vos jetons sous Profil — ouvrez le menu de profil (en haut à droite) ▸ Profil et utilisez la section des jetons d'API.
Pour du code d'intégration exécutable de bout en bout, consultez l'exemple détaillé Générateur de rapports externe.
Fonctionnalités associées
- Jetons d'API — créer et gérer les jetons restreints qui authentifient vos appels d'API
- API d'export de métriques — récupérer les données de production et de capteurs au format CSV ou JSON
- MiroxQL — construire et interroger des métriques dérivées avec le moteur d'export par formule
- Système d'autorisations — comment les rôles et les groupes d'autorisations régissent l'accès à l'API