{"id":32486,"date":"2023-03-08T16:31:06","date_gmt":"2023-03-08T15:31:06","guid":{"rendered":"https:\/\/mimolive.com\/?post_type=user-manual&#038;p=32486"},"modified":"2024-10-08T09:55:45","modified_gmt":"2024-10-08T07:55:45","slug":"http-api","status":"publish","type":"user-manual","link":"https:\/\/mimolive.com\/fr\/user-manual\/remote-control-automation\/http-api\/","title":{"rendered":"API HTTP"},"content":{"rendered":"<p>D'une part, mimoLive publie une <a href=\"https:\/\/mimolive.com\/fr\/manuel-de-lutilisateur\/surfaces-de-telecommande\/\">Interface utilisateur de la t\u00e9l\u00e9commande<\/a> que vous pouvez utiliser pour cr\u00e9er des interfaces utilisateur personnalis\u00e9es que vous pouvez utiliser sur une tablette ou un appareil similaire pour t\u00e9l\u00e9commander mimoLive.<\/p>\n\n\n\n<p>En outre, mimoLive permet d'acc\u00e9der \u00e0 l'ensemble de l'infrastructure de l'entreprise. <span class=\"caps\">HTTP<\/span> <span class=\"caps\">API<\/span> afin que vous puissiez cr\u00e9er des scripts personnalis\u00e9s (par l'interm\u00e9diaire de <strong>bash<\/strong> et <strong>boucler<\/strong>, <strong>AppleScript<\/strong>, int\u00e9gr\u00e9 <a href=\"https:\/\/mimolive.com\/fr\/manuel-de-lutilisateur\/lautomatisation\/\">Couche d'automatisation<\/a> ou quelque chose de similaire qui peut parler \u00e0 un <span class=\"caps\">HTTP<\/span> ) qui contr\u00f4lent divers aspects de mimoLive - les possibilit\u00e9s sont presque infinies. (Voir <a href=\"https:\/\/mimolive.com\/fr\/manuel-de-lutilisateur\/exemples-dutilisation-de-lapi\/\">Exemples de <span class=\"caps\">API<\/span> utilisation<\/a>)<\/p>\n\n\n\n<p>Dans ce th\u00e8me, nous nous concentrerons sur le nu <span class=\"caps\">HTTP<\/span> <span class=\"caps\">API<\/span>. En tant que <span class=\"caps\">API<\/span> est bas\u00e9 sur le <a href=\"http:\/\/jsonapi.org\/\" target=\"_blank\" rel=\"noreferrer noopener\">json:sp\u00e9cification de l'api<\/a> assurez-vous de vous familiariser avec elle avant de travailler avec le mimoLive <span class=\"caps\">API<\/span>.<\/p>\n\n\n\n<p>*En plus de la documentation, vous pouvez \u00e9galement consulter nos scripts de d\u00e9monstration PHP sur github.<\/p>\n\n\n\n<p><br>Un exemple pour Shell et Apple Script est \u00e9galement disponible.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"api-endpoint\"><span class=\"caps\">API<\/span> Acc\u00e8s<\/h3>\n\n\n\n<p>Le mimoLive <span class=\"caps\">API<\/span> est accessible sur la m\u00eame machine que mimoLive (via \"localhost\") et sur le r\u00e9seau local (via \".local\").<\/p>\n\n\n\n<p>Si cette option est activ\u00e9e, mimoLive sert de <span class=\"caps\">HTTP<\/span> sur le \"port 8989\".<\/p>\n\n\n\n<p>Tous les <span class=\"caps\">API<\/span> sont pr\u00e9c\u00e9d\u00e9s d'un chemin d'acc\u00e8s \"\/api\/v1\/\". Ainsi, si vous souhaitez obtenir une liste des documents ouverts, vous devez appeler \"http:\/\/localhost:8989\/api\/v1\/documents\".<\/p>\n\n\n\n<p>Tous les identifiants (pour les documents, les couches, les sources, les destinations de sortie, etc.) sont stock\u00e9s et conserv\u00e9s sur le disque, de sorte que le codage en dur de ces valeurs est s\u00fbr tant que le m\u00eame document est utilis\u00e9 dans mimoLive.<br><br>Veuillez vous r\u00e9f\u00e9rer \u00e0 <a href=\"https:\/\/mimolive.com\/fr\/manuel-de-lutilisateur\/personnalisation\/http-api\/points-finaux\/\" data-type=\"user-manual\" data-id=\"32488\">Points d'extr\u00e9mit\u00e9 de l'API<\/a> pour en savoir plus sur tous les points de terminaison propos\u00e9s.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"authentication\">Authentification<\/h3>\n\n\n\n<p>\u00c0 partir de mimoLive 3.1, si l'utilisateur a activ\u00e9 l'authentification dans les pr\u00e9f\u00e9rences de mimoLive, vous devez fournir le mot de passe de l'utilisateur pour chaque demande d'acc\u00e8s \u00e0 l'application <span class=\"caps\">API<\/span> ce qui peut se faire de deux mani\u00e8res :<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>R\u00e9glage de la personnalisation <span class=\"caps\">HTTP<\/span> header \"X-MimoLive-Password-SHA256 : xxxxxxx\"<\/li>\n\n\n\n<li>Ajout du param\u00e8tre de requ\u00eate \"?pwSHA256=xxxxxxx\"<\/li>\n<\/ul>\n\n\n\n<p>Dans les deux cas, xxxxxxx doit \u00eatre remplac\u00e9 par le mot de passe original (en <span class=\"caps\">UTF<\/span>-8) en utilisant le codage <span class=\"caps\">SHA<\/span>-256 et cod\u00e9e sous forme de cha\u00eene de chiffres hexad\u00e9cimaux.<br>Pour faciliter le d\u00e9veloppement de scripts et d'applications personnalis\u00e9s, mimoLive affiche ceci <span class=\"caps\">API<\/span> et permet la copie dans le presse-papiers dans le panneau de pr\u00e9f\u00e9rences T\u00e9l\u00e9commandes :<\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img fetchpriority=\"high\" decoding=\"async\" width=\"1000\" height=\"448\" src=\"https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/dddc6bf5-964b-493c-b35e-ee5b37e44e40.png\" alt=\"\" class=\"wp-image-32487\" srcset=\"https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/dddc6bf5-964b-493c-b35e-ee5b37e44e40.png 1000w,  https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/dddc6bf5-964b-493c-b35e-ee5b37e44e40-300x134.png 300w,  https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/dddc6bf5-964b-493c-b35e-ee5b37e44e40-768x344.png 768w,  https:\/\/mimolive.com\/wp-content\/uploads\/2023\/03\/dddc6bf5-964b-493c-b35e-ee5b37e44e40-18x8.png 18w\" sizes=\"(max-width: 1000px) 100vw, 1000px\" \/><\/figure>\n\n\n\n<h4 class=\"wp-block-heading\" id=\"deprecated-authentication-method\">M\u00e9thode d'authentification obsol\u00e8te<\/h4>\n\n\n\n<p>Avant la version 3.1 de mimoLive, les demandes concernant la fonction <span class=\"caps\">API<\/span> serait authentifi\u00e9 \u00e0 l'aide de l'identifiant sp\u00e9cial <span class=\"caps\">HTTP<\/span> X-MimoLive-Password : \" ou le param\u00e8tre de requ\u00eate \"?pw=\" \u00e0 chaque demande.<br>Malheureusement, cette m\u00e9thode envoie le mot de passe en clair via une connexion r\u00e9seau potentiellement non s\u00e9curis\u00e9e, ce qui peut exposer des donn\u00e9es sensibles si le <span class=\"caps\">HTTP<\/span> <span class=\"caps\">API<\/span> est r\u00e9utilis\u00e9 ailleurs.<br>Bien qu'elle continue de fonctionner, cette m\u00e9thode d'authentification est donc d\u00e9conseill\u00e9e et pourrait \u00eatre supprim\u00e9e \u00e0 l'avenir.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"errors\">Erreurs<\/h3>\n\n\n\n<p>Si une erreur survient au cours d'une demande, mimoLive interrompt le traitement de cette demande et renvoie un message d'erreur de type <span class=\"caps\">HTTP<\/span> avec son code d'\u00e9tat indiquant l'erreur. La r\u00e9ponse contient \u00e9galement un <span class=\"caps\">JSON<\/span> tableau d'objets d'erreur contenant des informations suppl\u00e9mentaires sur chaque erreur survenue :<\/p>\n\n\n\n<pre class=\"wp-block-code\" data-no-translation=\"\"><code>{\n  \"errors\": &#91;\n    {\n      \"status\": \"404\",\n      \"title\": \"Not Found\",\n      \"description\": \"The requested object could not be found\"\n    }\n  ]\n}<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"remote-access\">Acc\u00e8s \u00e0 distance via l'internet<\/h3>\n\n\n\n<p>En tant que <span class=\"caps\">HTTP<\/span> <span class=\"caps\">API<\/span> est activ\u00e9 par un serveur web int\u00e9gr\u00e9 \u00e0 mimoLive, l'acc\u00e8s \u00e0 distance \u00e0 l'espace de travail est possible. <span class=\"caps\">HTTP<\/span> <span class=\"caps\">API<\/span> depuis n'importe quel endroit de l'Internet en attribuant \u00e0 l'ordinateur mimoLive un num\u00e9ro IP public. \u00c9tant donn\u00e9 que l'ordinateur mimoLive <span class=\"caps\">HTTP<\/span> <span class=\"caps\">API<\/span> n'est pas tr\u00e8s bien prot\u00e9g\u00e9, c'est une mauvaise id\u00e9e. Une meilleure fa\u00e7on de permettre l'acc\u00e8s \u00e0 distance au <span class=\"caps\">HTTP<\/span> <span class=\"caps\">API<\/span> via un r\u00e9seau public est de <a href=\"https:\/\/mimolive.com\/fr\/manuel-de-lutilisateur\/acceder-a-distance-aux-surfaces-de-controle-et-a-lapi-http\/\">\u00e9tablir un tunnel s\u00e9curis\u00e9 vers votre ordinateur h\u00f4te mimoLive \u00e0 l'aide de ngrok<\/a>.<\/p>","protected":false},"excerpt":{"rendered":"<p>On one hand, mimoLive publishes a Remote Control UI which you can use to create custom user interfaces that you can use on a tablet or similar device to remote control mimoLive. Additionally, mimoLive provides access to the bare HTTP API so you can create custom scripts (via bash and curl, AppleScript, build-in Automation Layer [&hellip;]<\/p>","protected":false},"author":3,"featured_media":0,"parent":40865,"menu_order":2,"template":"","meta":{"_acf_changed":false,"_angie_page":false,"_lmt_disableupdate":"","_lmt_disable":"","footnotes":""},"categories":[258],"tags":[],"class_list":["post-32486","user-manual","type-user-manual","status-publish","hentry","category-manual"],"acf":[],"_links":{"self":[{"href":"https:\/\/mimolive.com\/fr\/wp-json\/wp\/v2\/user-manual\/32486","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/mimolive.com\/fr\/wp-json\/wp\/v2\/user-manual"}],"about":[{"href":"https:\/\/mimolive.com\/fr\/wp-json\/wp\/v2\/types\/user-manual"}],"author":[{"embeddable":true,"href":"https:\/\/mimolive.com\/fr\/wp-json\/wp\/v2\/users\/3"}],"version-history":[{"count":1,"href":"https:\/\/mimolive.com\/fr\/wp-json\/wp\/v2\/user-manual\/32486\/revisions"}],"predecessor-version":[{"id":39706,"href":"https:\/\/mimolive.com\/fr\/wp-json\/wp\/v2\/user-manual\/32486\/revisions\/39706"}],"up":[{"embeddable":true,"href":"https:\/\/mimolive.com\/fr\/wp-json\/wp\/v2\/user-manual\/40865"}],"wp:attachment":[{"href":"https:\/\/mimolive.com\/fr\/wp-json\/wp\/v2\/media?parent=32486"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/mimolive.com\/fr\/wp-json\/wp\/v2\/categories?post=32486"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/mimolive.com\/fr\/wp-json\/wp\/v2\/tags?post=32486"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}