API locale de l'appareil
Piloter un appareil enrôlé directement sur le réseau local : découverte, prérequis, format des réponses et des erreurs.
OpenMDM expose deux surfaces. L'API REST du serveur pilote la flotte depuis le cloud ; l'API locale est servie par l'appareil lui-même, sur le réseau local.
Elle répond en quelques millisecondes, fonctionne sans connexion Internet, et reste disponible quand le cloud ne l'est pas. C'est la surface à utiliser depuis une régie, une borne, ou tout automate situé sur le même réseau que les casques.
Quand l'utiliser
| Besoin | Surface |
|---|---|
| Piloter une flotte, déployer des contenus, exploiter des statistiques | API REST du serveur |
| Déclencher une action immédiate sur un appareil du réseau local | API locale |
| Réagir à un changement d'état en direct | Événements WebSocket |
URL de base
L'hôte est l'adresse IP de l'appareil, sur le port 8088 :
GET http://192.168.0.23:8088/restartL'IP est celle retournée par le mécanisme de découverte mDNS de l'application. Elle est aussi remontée au serveur, et donc lisible via l'API REST.
Prérequis
L'appareil doit être enrôlé et connecté au même réseau que le client qui l'appelle. Un appareil non enrôlé ne sert pas cette API.
Authentification
Il n'y en a pas. L'API locale ne demande ni jeton, ni en-tête particulier : toute machine
capable d'atteindre le port 8088 de l'appareil peut envoyer des commandes.
Elle est donc conçue pour un réseau local maîtrisé. Concrètement :
- n'exposez jamais le port
8088sur Internet, ni à travers une redirection de port ; - placez les casques sur un réseau ou un VLAN dédié lorsque c'est possible ;
- pour un pilotage depuis l'extérieur, passez par l'API REST du serveur, qui est authentifiée par jeton.
Format des réponses
Toutes les réponses sont en JSON. Les commandes qui ne renvoient pas de donnée répondent
204 No Content, sans corps.
Format des erreurs
Une erreur renvoie un code HTTP 4xx et un corps portant un unique champ message :
{
"message": "message de l'erreur"
}Ce message est destiné à être affiché tel quel : il décrit la cause en clair, par exemple
un packageName absent de l'appareil ou une valeur de volume hors bornes.
Les endpoints
Commandes de l'appareil
Faire sonner, régler le volume, lancer une application, redémarrer.
Lecteur vidéo
Lecture, pause, reprise, arrêt, seek et sourdine.
Informations et contenus
État de l'appareil, batterie, stockage, et inventaire des contenus.
Événements WebSocket
Recevoir les changements d'état en direct plutôt que d'interroger l'appareil.
Cette page vous a-t-elle aidé ?
Dernière mise à jour le