本文へ移動
ドキュメント

Team API クイックスタート

公式ローカルスターターを Team 所有の Developer app に接続し、VR 一覧を取得して認可済みシーンを表示します。

このページの内容
公式スターターv1.3.0

ローカルで動かす

React + TypeScript の完全なプロジェクトです。Node 24 が必要です。

まずデモを実行してから Team に接続してください。キーはローカルサーバーの .envに保存し、チャットには貼り付けないでください。

ターミナルを操作できる AI コーディングツールに貼り付けてください。アプリの起動と確認を依頼するプロンプトです。

Markdown を表示

公開 Five SDK クイックスタート と同じ React + TypeScript を使います。先に公開シーンを動かし、ローカル Node バックエンドを実 Team データに接続します。製品機能ごとに別アプリは不要です。

Developer app を準備する

アプリ一覧 で所有 Team と既存の有効アプリを選びます。空きがあれば Team オーナーが作成できます。期限切れ・無効も 10 個の上限に含みます。

コーディングツールを認可するときにこの Team とアプリを選びます。認証情報を AI チャットやコミュニティに含めないでください。

プロジェクトを起動する

上の「スターター用プロンプトをコピー」を使うか、リリースマニフェスト に従って取得・展開し、次を実行します:

npm ci
npm run check
npm run build
npm run dev

公開デモを先に確認します。その成功を Team 認証情報の検証とみなしてはいけません。

ローカルのバックエンドを設定する

展開したプロジェクトで初期設定ツールを実行します:

npm run configure -- --device

表示された確認 URL を開き、8 文字のコードを確認します。ログインして所有 Team とアプリを選び、Authorize agent を実行します。コマンドは起動したままにします。認証情報を出力せず .env に保存し、既存の空でない値は保持します。コードは 10 分で期限切れとなり、設定を 1 回だけ取得できます。

デバイス認可ページ でコードを手入力することもできます。

手動で設定する

.env がなければ package.json の隣に .env.example をコピーします。既存ファイルは保持し、必要な値だけ更新します。自分のコンピューターで入力し、SK・トークンを AI チャット、ブラウザー、URL、画像、ログに含めないでください。

REALSEE_APP_KEY=YOUR_APP_AK
REALSEE_APP_SECRET=YOUR_APP_SK
REALSEE_TEAM_SOURCE=YOUR_OWNING_TEAM_SOURCE
REALSEE_GATEWAY_BASE_URL=https://app-gateway.realsee.ai

変更後は Ctrl+C で停止し npm run dev を再実行します。表示された URL で Your Team を選び Check API & list VRs を押します。タブの切り替えだけでは API 確認を開始しません。バックエンドが環境を読み、ブラウザーに SK やトークンは渡りません。

トークンと VR 一覧を確認する

サーバーの固定版 @realsee/api で次の読み取りを行います:

  1. POST /auth/access_token に app_key と app_secret を送り交換します。
  2. HTTP と業務 code を確認し、data.access_token と返された data.expire_at を使います。
  3. POST /open/v3/custom/search に JSON の source、page、page_size を渡します。Authorization は Bearer なしの生のトークンです。
  4. VR 一覧とページ情報を表示します。

認可済みの空一覧は表示可能な VR がない状態です。API connected, no VRs available と報告します。別アプリの作成は不要で、Team シーンの表示成功ではありません。

VR があれば Team VRs と現在のページが表示されます。Next と Previous で移動します。

VR を選択して表示する

Team VRs の VR を選び、ビューアーの Ready を待ちます。バックエンドは設定済み Team に選択を紐付け、GET /open/v3/vr/info?resource_code=... で Work を取得して描画可能データを返します。

公開 Work API は data に描画用データを返します。スターターは @realsee/five@6.9.2 で解析します。リソースとアセットの利用可否はアプリ・Team・Work に依存し、単なるメタデータを描画済みシーンとみなしてはいけません。

共通ビューアーでデータを読みます。成功後にのみ Team scene ready と報告してください。Work やアセットの失敗は表示したままにし、公開デモで隠さないでください。

一覧からの選択は 5 分後 またはサーバー再起動で失効します。Refresh Team directory で再取得して選び直してください。

失敗を理解する

結果意味と対応
設定不足デバイス認可または指定変数をローカルで入力し再起動。公開デモは利用可能。
トークン失敗アプリ、認証情報、ゲートウェイを確認。HTTP 200 だけでは成功ではありません。
リソース要求失敗Team source、アプリ状態、業務結果を確認。
VR なし読み取り成功だが対象なし。公開デモを使うかアクセス可能な VR を準備。
選択期限切れ一覧を更新して再選択。
Work・アセット失敗選択 VR とネットワークを確認。API と描画の成功は別です。

開発を続ける