{"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\/es\/user-manual\/remote-control-automation\/http-api\/","title":{"rendered":"API HTTP"},"content":{"rendered":"<p>Por un lado, mimoLive publica un <a href=\"https:\/\/mimolive.com\/es\/manual-del-usuario\/superficies-de-control-remoto\/\">Interfaz de usuario del mando a distancia<\/a> que puedes utilizar para crear interfaces de usuario personalizadas que puedes usar en una tableta o dispositivo similar para controlar mimoLive a distancia.<\/p>\n\n\n\n<p>Adem\u00e1s, mimoLive proporciona acceso al <span class=\"caps\">HTTP<\/span> <span class=\"caps\">API<\/span> para que pueda crear scripts personalizados (mediante <strong>bash<\/strong> y <strong>rizo<\/strong>, <strong>AppleScript<\/strong>, integrar <a href=\"https:\/\/mimolive.com\/es\/manual-del-usuario\/automatizacion\/\">Capa de automatizaci\u00f3n<\/a> o algo similar que pueda hablar con un <span class=\"caps\">HTTP<\/span> server) que controlan varios aspectos de mimoLive - las posibilidades son casi infinitas. (V\u00e9ase <a href=\"https:\/\/mimolive.com\/es\/manual-del-usuario\/ejemplos-de-uso-de-la-api\/\">Ejemplos de <span class=\"caps\">API<\/span> uso<\/a>)<\/p>\n\n\n\n<p>En este tema, nos centraremos en el <span class=\"caps\">HTTP<\/span> <span class=\"caps\">API<\/span>. Como el <span class=\"caps\">API<\/span> se basa en el <a href=\"http:\/\/jsonapi.org\/\" target=\"_blank\" rel=\"noreferrer noopener\">json:especificaci\u00f3n api<\/a> familiar\u00edcese con \u00e9l antes de trabajar con mimoLive <span class=\"caps\">API<\/span>.<\/p>\n\n\n\n<p>*Adem\u00e1s de la documentaci\u00f3n, tambi\u00e9n puedes echar un vistazo a nuestros scripts PHP de demostraci\u00f3n en github<\/p>\n\n\n\n<p><br>Tambi\u00e9n hay disponible un ejemplo para Shell y Apple Script.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"api-endpoint\"><span class=\"caps\">API<\/span> Acceda a<\/h3>\n\n\n\n<p>El mimoLive <span class=\"caps\">API<\/span> es accesible en la misma m\u00e1quina en la que se ejecuta mimoLive (a trav\u00e9s de \"localhost\") y en la red local (a trav\u00e9s de \".local\").<\/p>\n\n\n\n<p>Si est\u00e1 activado, mimoLive sirve un <span class=\"caps\">HTTP<\/span> servidor en el \"puerto 8989\".<\/p>\n\n\n\n<p>Todos los <span class=\"caps\">API<\/span> llevan como prefijo una ruta \"\/api\/v1\/\", de modo que si desea obtener una lista de los documentos abiertos, deber\u00e1 llamar a \"http:\/\/localhost:8989\/api\/v1\/documents\".<\/p>\n\n\n\n<p>Todos los identificadores (para documentos, capas, fuentes, destinos de salida, etc.) se almacenan y persisten en el disco, por lo que la codificaci\u00f3n de estos valores es segura siempre que se utilice el mismo documento dentro de mimoLive.<br><br>Consulte <a href=\"https:\/\/mimolive.com\/es\/manual-del-usuario\/personalizacion\/http-api\/puntos-finales\/\" data-type=\"user-manual\" data-id=\"32488\">Puntos finales de la API<\/a> para obtener m\u00e1s informaci\u00f3n sobre todos los puntos finales proporcionados.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"authentication\">Autenticaci\u00f3n<\/h3>\n\n\n\n<p>A partir de mimoLive 3.1, si el usuario habilit\u00f3 la autenticaci\u00f3n en las preferencias de mimoLive, deber\u00e1 proporcionar la contrase\u00f1a de usuario para cada solicitud a la funci\u00f3n <span class=\"caps\">API<\/span> lo que puede hacerse de dos maneras:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Establecer la costumbre <span class=\"caps\">HTTP<\/span> header \"X-MimoLive-Password-SHA256: xxxxxxx\"<\/li>\n\n\n\n<li>A\u00f1adiendo el par\u00e1metro de consulta \"?pwSHA256=xxxxxxx\"<\/li>\n<\/ul>\n\n\n\n<p>En ambos casos, xxxxxxx debe sustituirse por la contrase\u00f1a original (en <span class=\"caps\">UTF<\/span>-8 encoding) hashed using <span class=\"caps\">SHA<\/span>-256 y codificada como una cadena de d\u00edgitos hexadecimales.<br>Para facilitar el desarrollo de scripts y aplicaciones personalizadas, mimoLive muestra lo siguiente <span class=\"caps\">API<\/span> y permite copiar al portapapeles en el panel de preferencias Controles remotos:<\/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\u00e9todo de autenticaci\u00f3n obsoleto<\/h4>\n\n\n\n<p>Con anterioridad a la versi\u00f3n 3.1 de mimoLive, las solicitudes a la base de datos <span class=\"caps\">API<\/span> se autenticar\u00edan utilizando el c\u00f3digo especial <span class=\"caps\">HTTP<\/span> encabezado \"X-MimoLive-Password: \" o el par\u00e1metro de consulta \"?pw=\" en cada solicitud.<br>Por desgracia, este m\u00e9todo env\u00eda la contrase\u00f1a en claro a trav\u00e9s de una conexi\u00f3n de red potencialmente insegura que puede exponer datos sensibles si el <span class=\"caps\">HTTP<\/span> <span class=\"caps\">API<\/span> contrase\u00f1a est\u00e1 siendo reutilizada en otro lugar.<br>Aunque sigue funcionando, se desaconseja este m\u00e9todo de autenticaci\u00f3n y es posible que se elimine en el futuro.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"errors\">Errores<\/h3>\n\n\n\n<p>Si se produce un error durante una solicitud, mimoLive dejar\u00e1 de procesar esa solicitud y devolver\u00e1 un mensaje <span class=\"caps\">HTTP<\/span> con su c\u00f3digo de estado indicando el error. La respuesta tambi\u00e9n contiene un <span class=\"caps\">JSON<\/span> matriz de carga \u00fatil de objetos de error que contiene informaci\u00f3n adicional sobre cada error que se ha producido:<\/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\">Acceso remoto por Internet<\/h3>\n\n\n\n<p>Como el <span class=\"caps\">HTTP<\/span> <span class=\"caps\">API<\/span> est\u00e1 habilitado por un servidor web integrado en mimoLive, el acceso remoto al <span class=\"caps\">HTTP<\/span> <span class=\"caps\">API<\/span> desde cualquier lugar de Internet se puede habilitar dando al ordenador mimoLive un n\u00famero IP p\u00fablico. Dado que el <span class=\"caps\">HTTP<\/span> <span class=\"caps\">API<\/span> no est\u00e1 muy bien protegido, esto es una mala idea. Una mejor manera de habilitar el acceso remoto a la <span class=\"caps\">HTTP<\/span> <span class=\"caps\">API<\/span> a trav\u00e9s de una red p\u00fablica es <a href=\"https:\/\/mimolive.com\/es\/manual-del-usuario\/acceda-a-superficies-de-control-remoto-y-http-api-de-forma-remota\/\">establezca un t\u00fanel seguro con su ordenador host mimoLive mediante 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\/es\/wp-json\/wp\/v2\/user-manual\/32486","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/mimolive.com\/es\/wp-json\/wp\/v2\/user-manual"}],"about":[{"href":"https:\/\/mimolive.com\/es\/wp-json\/wp\/v2\/types\/user-manual"}],"author":[{"embeddable":true,"href":"https:\/\/mimolive.com\/es\/wp-json\/wp\/v2\/users\/3"}],"version-history":[{"count":1,"href":"https:\/\/mimolive.com\/es\/wp-json\/wp\/v2\/user-manual\/32486\/revisions"}],"predecessor-version":[{"id":39706,"href":"https:\/\/mimolive.com\/es\/wp-json\/wp\/v2\/user-manual\/32486\/revisions\/39706"}],"up":[{"embeddable":true,"href":"https:\/\/mimolive.com\/es\/wp-json\/wp\/v2\/user-manual\/40865"}],"wp:attachment":[{"href":"https:\/\/mimolive.com\/es\/wp-json\/wp\/v2\/media?parent=32486"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/mimolive.com\/es\/wp-json\/wp\/v2\/categories?post=32486"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/mimolive.com\/es\/wp-json\/wp\/v2\/tags?post=32486"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}