Por un lado, mimoLive publica un Interfaz de usuario del mando a distancia que puedes utilizar para crear interfaces de usuario personalizadas que puedes usar en una tableta o dispositivo similar para controlar mimoLive a distancia.
Además, mimoLive proporciona acceso al HTTP API para que pueda crear scripts personalizados (mediante bash y rizo, AppleScript, integrar Capa de automatización o algo similar que pueda hablar con un HTTP server) que controlan varios aspectos de mimoLive - las posibilidades son casi infinitas. (Véase Ejemplos de API uso)
En este tema, nos centraremos en el HTTP API. Como el API se basa en el json:especificación api familiarícese con él antes de trabajar con mimoLive API.
*Además de la documentación, también puedes echar un vistazo a nuestros scripts PHP de demostración en github
También hay disponible un ejemplo para Shell y Apple Script.
API Punto final
El mimoLive API es accesible en la misma máquina en la que se ejecuta mimoLive (a través de "localhost") y en la red local (a través de ".local").
Si está activado, mimoLive sirve un HTTP servidor en el "puerto 8989".
Todos los API llevan como prefijo una ruta "/api/v1/", de modo que si desea obtener una lista de los documentos abiertos, deberá llamar a "http://localhost:8989/api/v1/documents".
Todos los IDs (para documentos, capas, etc.) se almacenan y persisten en el disco, por lo que la codificación de estos valores es segura siempre y cuando el mismo documento se utilice dentro de mimoLive.
Autenticación
A partir de mimoLive 3.1, si el usuario habilitó la autenticación en las preferencias de mimoLive, deberá proporcionar la contraseña de usuario para cada solicitud a la función API lo que puede hacerse de dos maneras:
- Establecer la costumbre HTTP header "X-MimoLive-Password-SHA256: xxxxxxx"
- Añadiendo el parámetro de consulta "?pwSHA256=xxxxxxx"
En ambos casos, xxxxxxx debe sustituirse por la contraseña original (en UTF-8 encoding) hashed using SHA-256 y codificada como una cadena de dígitos hexadecimales.
Para facilitar el desarrollo de scripts y aplicaciones personalizadas, mimoLive muestra lo siguiente API y permite copiar al portapapeles en el panel de preferencias Controles remotos:
Método de autenticación obsoleto
Con anterioridad a la versión 3.1 de mimoLive, las solicitudes a la base de datos API se autenticarían utilizando el código especial HTTP encabezado "X-MimoLive-Password: " o el parámetro de consulta "?pw=" en cada solicitud.
Por desgracia, este método envía la contraseña en claro a través de una conexión de red potencialmente insegura que puede exponer datos sensibles si el HTTP API contraseña está siendo reutilizada en otro lugar.
Aunque sigue funcionando, se desaconseja este método de autenticación y es posible que se elimine en el futuro.
Errores
Si se produce un error durante una solicitud, mimoLive dejará de procesar esa solicitud y devolverá un mensaje HTTP con su código de estado indicando el error. La respuesta también contiene un JSON matriz de carga útil de objetos de error que contiene información adicional sobre cada error que se ha producido:
{
"errors": [
{
"status": "404",
"title": "Not Found",
"description": "The requested object could not be found"
}
]
}Acceso remoto por Internet
Como el HTTP API está habilitado por un servidor web integrado en mimoLive, el acceso remoto al HTTP API desde cualquier lugar de Internet se puede habilitar dando al ordenador mimoLive un número IP público. Dado que el HTTP API no está muy bien protegido, esto es una mala idea. Una mejor manera de habilitar el acceso remoto a la HTTP API a través de una red pública es establezca un túnel seguro con su ordenador host mimoLive mediante ngrok.