HTTP API

목차

한편으로, mimoLive는 태블릿 또는 이와 유사한 디바이스에서 원격 제어를 위해 사용할 수 있는 사용자 지정 사용자 인터페이스를 만드는 데 사용할 수 있는 원격 제어 UI를 게시하고 있습니다.

또한, mimoLive는 베어본에 대한 액세스를 제공합니다. HTTP API 를 통해 사용자 지정 스크립트를 만들 수 있습니다( bash 그리고 curl, AppleScript빌트인 자동화 계층 또는 이와 유사한 무언가와 대화할 수 있는 HTTP 서버)를 통해 mimoLive의 다양한 측면을 제어할 수 있으며, 그 가능성은 거의 무한합니다. (참조 예시 API 사용법)

이 주제에서는 베어 HTTP API. 로 APIJSON:API 사양 미모라이브로 작업하기 전에 반드시 숙지하세요. API.

*문서 외에도 github에서 PHP 데모 스크립트를 살펴볼 수 있습니다.


또한 셸 및 애플 스크립트에 대한 예제도 제공됩니다.

API 액세스

미모라이브 API 는 미모라이브가 실행 중인 동일한 컴퓨터("localhost"를 통해)와 로컬 네트워크(".local"을 통해)에서 액세스할 수 있습니다.

미모라이브를 활성화하면 HTTP 서버를 "포트 8989"에 연결합니다.

모든 API 호출에는 "/api/v1/" 경로가 앞에 붙으므로 열려 있는 문서 목록을 가져오려면 "http://localhost:8989/api/v1/documents"를 호출하면 됩니다.

모든 ID(문서, 레이어, 소스, 출력 대상 등)는 디스크에 저장되고 유지되므로 동일한 문서가 mimoLive 내에서 사용되는 한 이러한 값을 하드코딩하는 것은 안전합니다.

제공된 모든 엔드포인트에 대해 자세히 알아보려면 API 엔드포인트를 참조하세요.

인증

mimoLive 3.1부터 사용자가 mimoLive 환경설정에서 인증을 활성화한 경우, 모든 요청에 대해 사용자 비밀번호를 제공해야 합니다. API 두 가지 방법으로 수행할 수 있습니다:

  • 사용자 지정 설정 HTTP 헤더 "X-MimoLive-Password-SHA256: xxxxxxx"
  • 쿼리 매개변수 "?pwSHA256=xxxxxxx"를 추가합니다.

두 경우 모두 xxxxxxx를 원래 비밀번호로 대체해야 합니다( UTF-8 인코딩)을 사용하여 해시된 SHA-256이며 16진수 문자열로 인코딩됩니다.
사용자 지정 스크립트 및 애플리케이션을 쉽게 개발할 수 있도록 mimoLive는 다음을 보여줍니다. API 키를 누르고 원격 제어 환경설정 창에서 클립보드에 복사할 수 있습니다:

DDDC6BF5 964B 493C B35E EE5B37E44E40

사용되지 않는 인증 방법

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 공용 네트워크를 통해 ngrok을 사용하여 미모라이브 호스트 컴퓨터에 보안 터널을 설정합니다..

피드백

mimoLive®의 이 기능에 대한 경험은 어떻게 평가하시나요?

사용자 설명서: 최근 업데이트

언어 선택