D'une part, mimoLive publie une IU de contrôle à distance que vous pouvez utiliser pour créer des interfaces utilisateur personnalisées que vous pouvez utiliser sur une tablette ou un appareil similaire pour contrôler mimoLive à distance.
En outre, mimoLive permet d'accéder à l'ensemble de l'infrastructure de l'entreprise. HTTP API afin que vous puissiez créer des scripts personnalisés (par l'intermédiaire de bash et boucler, AppleScript, intégré Couche d'automatisation ou quelque chose de similaire qui peut parler à un HTTP ) qui contrôlent divers aspects de mimoLive - les possibilités sont presque infinies. (Voir Exemples de API utilisation)
Dans ce thème, nous nous concentrerons sur le nu HTTP API. En tant que API est basé sur le json:spécification de l'api assurez-vous de vous familiariser avec elle avant de travailler avec le mimoLive API.
*En plus de la documentation, vous pouvez également consulter nos scripts de démonstration PHP sur github.
<Un exemple pour Shell et Apple Script est également disponible.
API Accès
Le mimoLive API est accessible sur la même machine que mimoLive (via "localhost") et sur le réseau local (via ".local").
Si cette option est activée, mimoLive sert de HTTP sur le "port 8989".
Tous les API sont précédés d'un chemin d'accès "/api/v1/". Ainsi, si vous souhaitez obtenir une liste des documents ouverts, vous devez appeler "http://localhost:8989/api/v1/documents".
Tous les ID (pour les documents, les couches, les sources, les destinations de sortie, etc.) sont stockés et conservés sur le disque, de sorte que le codage en dur de ces valeurs est sûr tant que le même document est utilisé dans mimoLive.
Veuillez vous reporter à API Endpoints pour en savoir plus sur tous les points de terminaison fournis.
Authentification
À partir de mimoLive 3.1, si l'utilisateur a activé l'authentification dans les préférences de mimoLive, vous devez fournir le mot de passe de l'utilisateur pour chaque demande d'accès à l'application API ce qui peut se faire de deux manières :
- Réglage de la personnalisation HTTP header "X-MimoLive-Password-SHA256 : xxxxxxx"
- Ajout du paramètre de requête "?pwSHA256=xxxxxxx"
Dans les deux cas, xxxxxxx doit être remplacé par le mot de passe original (en UTF-8) en utilisant le codage SHA-256 et codée sous forme de chaîne de chiffres hexadécimaux.
Pour faciliter le développement de scripts et d'applications personnalisés, mimoLive affiche ceci API et permet la copie dans le presse-papiers dans le panneau de préférences Télécommandes :
Méthode d'authentification obsolète
Avant la version 3.1 de mimoLive, les demandes concernant la fonction API serait authentifié à l'aide de l'identifiant spécial HTTP X-MimoLive-Password : " ou le paramètre de requête "?pw=" à chaque demande.
Malheureusement, cette méthode envoie le mot de passe en clair via une connexion réseau potentiellement non sécurisée, ce qui peut exposer des données sensibles si le HTTP API est réutilisé ailleurs.
Bien qu'elle continue de fonctionner, cette méthode d'authentification est donc déconseillée et pourrait être supprimée à l'avenir.
Erreurs
Si une erreur survient au cours d'une demande, mimoLive interrompt le traitement de cette demande et renvoie un message d'erreur de type HTTP avec son code d'état indiquant l'erreur. La réponse contient également un JSON tableau d'objets d'erreur contenant des informations supplémentaires sur chaque erreur survenue :
{
"errors": [
{
"status": "404",
"title": "Not Found",
"description": "The requested object could not be found"
}
]
}Accès à distance via l'internet
En tant que HTTP API est activé par un serveur web intégré à mimoLive, l'accès à distance à l'espace de travail est possible. HTTP API depuis n'importe quel endroit de l'Internet en attribuant à l'ordinateur mimoLive un numéro IP public. Étant donné que l'ordinateur mimoLive HTTP API n'est pas très bien protégé, c'est une mauvaise idée. Une meilleure façon de permettre l'accès à distance au HTTP API via un réseau public est de établir un tunnel sécurisé vers votre ordinateur hôte mimoLive à l'aide de ngrok.
