Da un lato, mimoLive pubblica una Interfaccia utente del telecomando con cui è possibile creare interfacce utente personalizzate da utilizzare su un tablet o un dispositivo simile per controllare a distanza mimoLive.
Inoltre, mimoLive fornisce l'accesso alla nuda HTTP API in modo da poter creare script personalizzati (tramite bash e ricciolo, AppleScript, incorporato Livello di automazione o qualcosa di simile che possa parlare con un HTTP server) che controllano vari aspetti di mimoLive: le possibilità sono quasi infinite. (Vedi Esempi di API utilizzo)
In questo argomento, ci concentreremo sul nudo HTTP API. Come il API si basa sulla specifiche json:api Assicurarsi di familiarizzare con esso prima di lavorare con mimoLive. API.
*Oltre alla documentazione, è possibile dare un'occhiata ai nostri script dimostrativi PHP su github
Inoltre, è disponibile un esempio per Shell e Apple Script.
API Punto finale
Il mimoLive API è accessibile sulla stessa macchina su cui gira mimoLive (tramite "localhost") e sulla rete locale (tramite ".local").
Se abilitato, mimoLive serve un HTTP server sulla "porta 8989".
Tutti i API Le chiamate sono precedute da un percorso di "/api/v1/", quindi se si vuole ottenere un elenco di documenti aperti si deve chiamare "http://localhost:8989/api/v1/documents".
Tutti gli ID (per documenti, livelli, ecc.) sono memorizzati e conservati su disco, quindi la codifica dei valori è sicura finché lo stesso documento viene utilizzato all'interno di mimoLive.
Autenticazione
A partire da mimoLive 3.1, se l'utente ha abilitato l'autenticazione nelle preferenze di mimoLive, è necessario fornire la password dell'utente per ogni richiesta al servizio di assistenza. API che può essere fatto in due modi:
- Impostazione dell'opzione personalizzata HTTP intestazione "X-MimoLive-Password-SHA256: xxxxxxx"
- Aggiunta del parametro di query "?pwSHA256=xxxxxxx".
In entrambi i casi, xxxxxxx deve essere sostituita con la password originale (in UTFcodifica -8) con un hash usando CSA-256 e codificato come una stringa di cifre esadecimali.
Per agevolare lo sviluppo di script e applicazioni personalizzate, mimoLive mostra questo API e consente di copiare negli appunti nel pannello delle preferenze dei Controlli remoti:
Metodo di autenticazione deprecato
Prima della versione 3.1 di mimoLive, le richieste contro il file API verrebbe autenticato utilizzando lo speciale HTTP L'intestazione "X-MimoLive-Password: " o il parametro di query "?pw=" su ogni richiesta.
Sfortunatamente, questo metodo invia la password in chiaro attraverso una connessione di rete potenzialmente insicura, che potrebbe esporre dati sensibili se il HTTP API La password viene riutilizzata altrove.
Pur continuando a funzionare, questo metodo di autenticazione è quindi sconsigliato e potrebbe essere rimosso in futuro.
Errori
Se si verifica un errore durante una richiesta, mimoLive interromperà l'elaborazione di quella richiesta e restituirà un messaggio HTTP con il suo codice di stato che indica l'errore. La risposta contiene anche un JSON array di oggetti errore contenenti informazioni aggiuntive su ciascun errore verificatosi:
{
"errors": [
{
"status": "404",
"title": "Not Found",
"description": "The requested object could not be found"
}
]
}Accesso remoto via Internet
Come il HTTP API è abilitato da un webserver integrato in mimoLive, l'accesso remoto alla HTTP API da qualsiasi punto di Internet può essere attivata assegnando al computer mimoLive un numero IP pubblico. Poiché il HTTP API non è molto protetto, questa è una cattiva idea. Un modo migliore per abilitare l'accesso remoto al file HTTP API attraverso una rete pubblica è quello di stabilire un tunnel sicuro verso il computer host mimoLive utilizzando ngrok.