Å ena sidan publicerar mimoLive en Användargränssnitt för fjärrkontroll som du kan använda för att skapa anpassade användargränssnitt som du kan använda på en surfplatta eller liknande enhet för att fjärrstyra mimoLive.
Dessutom ger mimoLive tillgång till de nakna HTTP API så att du kan skapa anpassade skript (via bash och krulla, AppleScript, inbyggd Automatiseringslager eller något liknande som kan prata med en HTTP server) som styr olika aspekter av mimoLive - möjligheterna är nästan oändliga. (Se Exempel på API användning)
I detta ämne kommer vi att fokusera på de nakna HTTP API. Eftersom API är baserad på json:api-specifikation se till att bekanta dig med den innan du börjar arbeta med mimoLive API.
*Förutom dokumentationen kan du också ta en titt på våra PHP-demoskript på github
Det finns även exempel för Shell och Apple Script.
API Slutpunkt
MimoLive API är tillgänglig på samma maskin som mimoLive körs på (via "localhost") och i det lokala nätverket (via ".local").
Om aktiverad tjänar mimoLive en HTTP server på "port 8989".
Alla de API anrop prefixeras med sökvägen "/api/v1/", så om du vill få en lista över öppnade dokument anropar du "http://localhost:8989/api/v1/documents".
Alla ID (för dokument, lager, etc.) lagras och persisteras på disk, så hårdkodning av dessa värden är säkert så länge samma dokument används i mimoLive.
Autentisering
Från och med mimoLive 3.1, om användaren har aktiverat autentisering i inställningarna för mimoLive, måste du ange användarens lösenord för varje förfrågan till API vilket kan göras på två sätt:
- Inställning av anpassning HTTP rubrik "X-MimoLive-Password-SHA256: xxxxxxx"
- Lägga till frågeparametern "?pwSHA256=xxxxxxx"
I båda fallen måste xxxxxxx ersättas med det ursprungliga lösenordet (i UTF-8-kodning) hashad med hjälp av SHA-256 och kodas som en sträng av hexadecimala siffror.
För att underlätta utvecklingen av anpassade skript och applikationer visar mimoLive detta API och möjliggör kopiering till Urklipp i inställningsfönstret Fjärrkontroller:
Föråldrad autentiseringsmetod
Före mimoLive version 3.1 kunde förfrågningar mot API skulle autentiseras med hjälp av den särskilda HTTP rubriken "X-MimoLive-Password: " eller frågeparametern "?pw=" på varje förfrågan.
Tyvärr skickar denna metod lösenordet i klartext över en potentiellt osäker nätverksanslutning, vilket kan avslöja känsliga uppgifter om HTTP API lösenord återanvänds någon annanstans.
Denna autentiseringsmetod fungerar visserligen fortfarande, men vi avråder från den och den kan komma att tas bort i framtiden.
Fel
Om ett fel uppstår under en begäran kommer mimoLive att avbryta behandlingen av begäran och returnera ett HTTP svar med dess statuskod som anger felet. Svaret innehåller också en JSON nyttolast matris med felobjekt som innehåller ytterligare information om varje fel som inträffade:
{
"errors": [
{
"status": "404",
"title": "Not Found",
"description": "The requested object could not be found"
}
]
}Fjärråtkomst via Internet
Eftersom HTTP API möjliggörs av en inbyggd webbserver i mimoLive, fjärråtkomst till HTTP API från var som helst på Internet kan möjliggöras genom att ge mimoLive-datorn ett offentligt IP-nummer. Eftersom HTTP API inte är särskilt väl skyddat, är detta en dålig idé. Ett bättre sätt att möjliggöra fjärråtkomst till HTTP API via ett publikt nätverk är att upprätta en säker tunnel till din mimoLive-värddator med hjälp av ngrok.