З одного боку, mimoLive публікує Інтерфейс дистанційного керування за допомогою якого ви можете створювати власні користувацькі інтерфейси, які можна використовувати на планшеті або подібному пристрої для дистанційного керування mimoLive.
Крім того, mimoLive надає доступ до HTTP API щоб ви могли створювати власні скрипти (за допомогою bash і скручуватися, AppleScript, вбудований Рівень автоматизації або щось подібне, що може розмовляти з HTTP сервер), які контролюють різні аспекти mimoLive - можливості майже безмежні. (Див. Приклади API використання)
У цій темі ми зосередимося на голих HTTP API. Як зазначено в API базується на Специфікація json:api обов'язково ознайомтеся з ним перед початком роботи з mimoLive API.
*На додаток до документації ви також можете переглянути наші демо-скрипти PHP на github
Також доступний приклад для Shell та Apple Script.
API Кінцева точка
mimoLive API доступний на тій самій машині, на якій запущено mimoLive (через "localhost") та у локальній мережі (через ".local").
Якщо увімкнено, mimoLive слугує HTTP на сервері "порт 8989".
Всі API виклики мають префікс "/api/v1/", тому, якщо ви хочете отримати список відкритих документів, ви повинні викликати "http://localhost:8989/api/v1/documents".
Усі ідентифікатори (для документів, шарів тощо) зберігаються на диску, тому жорстке кодування цих значень є безпечним, доки той самий документ використовується у mimoLive.
Аутентифікація
Починаючи з mimoLive 3.1, якщо користувач увімкнув автентифікацію в налаштуваннях mimoLive, вам потрібно надавати пароль користувача для кожного запиту до API Це можна зробити двома способами:
- Налаштування кастомізації HTTP заголовок "X-MimoLive-Password-SHA256: xxxxxxx"
- Додавання параметра запиту "?pwSHA256=xxxxxx"
В обох випадках xxxxxxx потрібно замінити на оригінальний пароль (в UTF-8 кодування) хешований з використанням SHA-256 і кодується як рядок шістнадцяткових цифр.
Щоб полегшити розробку користувацьких скриптів і додатків, mimoLive показує наступне API і дозволяє копіювання до буфера обміну на панелі налаштувань Пульта дистанційного керування:
Застарілий метод автентифікації
До версії mimoLive 3.1 запити до API будуть аутентифіковані за допомогою спеціального HTTP заголовок "X-MimoLive-Password: " або параметр запиту "?pw=" при кожному запиті.
На жаль, цей метод надсилає пароль у відкритому вигляді через потенційно незахищене мережеве з'єднання, що може призвести до витоку конфіденційних даних, якщо HTTP API пароль повторно використовується в іншому місці.
Хоча він продовжує працювати, цей метод автентифікації не рекомендується і може бути вилучений у майбутньому.
Помилки
Якщо під час виконання запиту виникне помилка, mimoLive припинить обробку цього запиту і поверне HTTP з кодом стану, що вказує на помилку. У відповіді також міститиметься JSON корисний масив об'єктів помилок, що містить додаткову інформацію про кожну помилку, яка сталася:
{
"errors": [
{
"status": "404",
"title": "Not Found",
"description": "The requested object could not be found"
}
]
}Віддалений доступ через Інтернет
Як зазначає HTTP API забезпечується вбудованим в mimoLive веб-сервером, віддалений доступ до HTTP API з будь-якої точки Інтернету можна увімкнути, надавши комп'ютеру mimoLive публічний IP-номер. З того часу, як HTTP API не дуже добре захищений, це погана ідея. Кращий спосіб увімкнути віддалений доступ до HTTP API через загальнодоступну мережу - це створіть безпечний тунель до хост-комп'ютера mimoLive за допомогою ngrok.