LabvancedのAPIアクセス: 概要
Labvancedは、異なるユースケースに適合する3つの主要なAPIを提供しています。それらについて以下に説明します:
REST API: REST APIは、実験およびセッションデータを取得し、録音が完了した後にプログラム的にダウンロードするために使用されます。Labvancedプラットフォーム内で一意のトークンが生成され、これを使用してデータにアクセスします。REST APIを使用すると、研究者はデータを自分のサーバー上で直接アクセスおよびダウンロードでき、データをダウンロードしてデバイスにローカルに保存する必要がないため、データ処理のパイプラインプロトコルを持つ組織にとって重要です。REST APIはすべてのLabvancedユーザーが利用可能です。 REST APIの利用方法について詳しく見る。
Webhook API: Webhook APIは、実験が録音されている間にデータを取得することを可能にします。これは、Labvancedの外部の指定したサーバーに保存するためにデータを送信する一方向の通信に使用されます。Labvanced外部データストレージWebhook APIの主なユースケースは、参加者のデータを“リアルタイム”でリモート/外部サーバーに転送することです。これは、録音および収集されたデータをLabvancedサーバーではなく外部にホストする代替手段です。この機能は、Labライセンスを持つユーザーにオンラインで利用可能です。Webhook APIは、Labvancedが収集した参加者データを直接あなたのデータベース/バックエンドに送信するために、あなたが指定したエンドポイントを自動的に呼び出すことができるように、バックエンドでの設定が必要ですのでご注意ください。 Webhook APIの実装方法について詳しく見る。
WebSocket API: カスタムWebSocket接続を使用すると、Labvancedを実行時に他のサーバーと接続することができます。これは、二方向にデータを送信する必要がある場面で使用されます。これにより、Labvancedをオンラインのサーバーまたはローカルホストと接続することができ、LSL統合を介してLabvancedと外部デバイスを接続する場合に該当します。これは、コンピュータ上で別のプログラムとしてローカルに実行して、基本的なPythonコードをカスタマイズし、あなたのラボ/研究ニーズに合うようにするスクリプトベースのソリューションで達成することができます。 WebSocket APIの使用方法について、いくつかのユースケース(例えば、あなたのデバイスをLabvancedに接続するため)をご覧ください。
興味のある関連APIに関する関連文書を確認し、質問があればお気軽にお問い合わせください!