mimoLive® - ユーザーマニュアル

HTTP API

目次

一方では、mimoLiveはリモートコントロールUIを公開しており、タブレットや同様のデバイスでmimoLiveをリモートコントロールするためのカスタムユーザーインターフェースを作成することができます。

さらに、mimoLiveでは、ベアへのアクセスも可能です。 HTTP エーピーアイ で、カスタムスクリプトを作成することができます(via バッシュカール, アップルスクリプトビルドイン オートメーション層 などと会話することができます。 HTTP サーバー)を使って、mimoLiveの様々な側面をコントロールすることができます。その可能性はほぼ無限大です。(参照 の例 エーピーアイ)

このトピックでは、素 HTTP エーピーアイ.として、その エーピーアイ がベースになっています。 json:api仕様 ミモライブで作業する前に、必ず熟知しておいてください。 エーピーアイ.

*ドキュメントに加え、githubにあるPHPのデモスクリプトもご覧ください。


また、シェルとアップルスクリプトの例もあります。

エーピーアイ アクセス

ミモライブの エーピーアイ は、mimoLiveが稼働している同じマシン上(「localhost」経由)およびローカルネットワーク上(「.local」経由)でアクセス可能です。

mimoLiveが有効な場合は、mimoLiveのサービスを提供します。 HTTP サーバーを「ポート8989」で使用します。

すべての エーピーアイ の呼び出しは、"/api/v1/"というパスが先頭に付くので、開いたドキュメントのリストを取得したい場合は、"http://localhost:8989/api/v1/documents "を呼び出します。



提供されるすべてのエンドポイントの詳細については、API Endpointsを参照してください。

オーセンティケーション

mimoLive 3.1以降、ユーザーがmimoLiveの環境設定で認証を有効にした場合、リクエストごとにユーザーのパスワードを エーピーアイ という2つの方法で行うことができます:

  • カスタムの設定 HTTP ヘッダー "X-MimoLive-Password-SHA256: xxxxxxx"
  • クエリパラメーター "?pwSHA256=xxxxxxxxx" の付加

どちらの場合も、xxxxxxxは元のパスワードに置き換える必要があります(中略)。 ユーティーエフ-8 エンコーディング)を用いてハッシュ化されます。 シャ-256であり、16進数の文字列としてエンコードされる。
カスタムスクリプトやアプリケーションの開発を容易にするために、mimoLiveではこのような表示をしています。 エーピーアイ キーで、「リモートコントロール」環境設定ペインでクリップボードへのコピーを可能にします:

dddc6bf5 964b 493c b35e ee5b37e44e40

非推奨の認証方式

mimoLiveバージョン3.1以前は、リクエストに対して エーピーアイ は、特別なものを使って認証されることになります。 HTTP ヘッダ "X-MimoLive-Password:" またはクエリパラメータ "?pw=" をすべてのリクエストで使用します。
残念ながら、この方法は、安全でない可能性のあるネットワーク接続を介してパスワードを平文で送信するため、機密データが漏洩する可能性があります。 HTTP エーピーアイ のパスワードは別の場所で再利用されています。
このため、この認証方法は推奨されず、将来的に削除される可能性があります。

エラース

リクエスト中にエラーが発生した場合、mimoLiveはそのリクエストの処理を停止して HTTP レスポンスには、エラーを示すステータスコードも含まれます。また、レスポンスには JSON 発生した各エラーに関する追加情報を含むエラーオブジェクトのペイロード配列:

{
  "errors": [
    {
      "status": "404",
      "title": "Not Found",
      "description": "The requested object could not be found"
    }
  ]
}

インターネットによるリモートアクセス

としています。 HTTP エーピーアイ は、mimoLiveに内蔵されたWebサーバーによって実現され、リモートアクセスで HTTP エーピーアイ は、mimoLiveコンピュータにパブリックIP番号を与えることで、インターネット上のどこからでも有効にすることができます。そのため HTTP エーピーアイ があまり保護されていない場合、これは悪いアイデアです。へのリモートアクセスを可能にする、より良い方法です。 HTTP エーピーアイ 公衆回線網を経由することは ngrokを使用してmimoLiveホストコンピュータに安全なトンネルを確立します。.

ご意見・ご感想

ミモライブのこの機能を使ってみて、どのように評価されますか?

ユーザーマニュアル最近の更新

言語の選択