# OpenAPI

Developer app の認証情報で、サーバーから Team の VR データと再構成 API に接続します。

Canonical: https://developer.realsee.ai/ja/docs/open-api
Source: https://developer.realsee.ai/ja/docs/open-api.md
Language: ja

# OpenAPI

Realsee **OpenAPI** は VR データ、操作、Live、Argus などの空間データと処理をサーバーに接続します。Team 所有の **Developer app** を作成または選択し、AK/SK でゲートウェイトークンを取得します。

[Team API スターター](https://developer.realsee.ai/ja/docs/open-api/quickstart) で、完全なローカルプロジェクトと AI 用プロンプト、トークン → 一覧 → 認可済み Work → Five SDK 表示を試せます。先に公開デモを動かしてからローカルで認証情報を設定します。

<span id="start-with-an-app" class="docs-anchor-alias" aria-hidden="true"></span>

## アプリから始める

[アプリ一覧](https://developer.realsee.ai/ja/dashboard/apps) で所有 Team と有効アプリを選び、詳細画面で AK/SK を取得します。作成、所有権、利用状態は [Team とアプリ管理](https://developer.realsee.ai/ja/docs/team-app-management) を参照してください。

<span id="base-url-and-authentication" class="docs-anchor-alias" aria-hidden="true"></span>

## ベース URL と認証

海外向けゲートウェイ：

```text
https://app-gateway.realsee.ai
```

サーバーで `POST /auth/access_token` にフォームの `app_key` と `app_secret` を送ります。応答は `data.access_token` と秒単位の Unix 時刻 `data.expire_at` を含みます。サーバーで保持し、返された期限に従って再取得してください。

`/open` には `Bearer` を付けず `Authorization` に生のトークンを送ります。[エンドポイントガイド](https://developer.realsee.ai/ja/docs/open-api/reference) は交換と前提条件、[認証](https://developer.realsee.ai/ja/docs/authentication) は取得と保護を説明します。

SK やトークンをブラウザー、URL、ログ、解析、サポート連絡に含めないでください。バックエンドで独自ユーザーを認可し、許可されたデータだけを返します。

<span id="choose-the-operation" class="docs-anchor-alias" aria-hidden="true"></span>

## 操作を選ぶ

メソッド、引数、応答スキーマは [API Reference](https://developer.realsee.ai/api-reference) を参照してください。

- **VR・シーンデータ**：Team が利用できるリソースを検索し、文書化された識別子で取得します。
- **操作と表示**：ホットスポット、定規、間取り図など、SDK 体験に必要な API を使います。
- **Live**：[Live ガイド](https://developer.realsee.ai/ja/docs/live) でルーム、ticket、接続、任意の音声要件を確認します。
- **Argus**：[Argus ガイド](https://developer.realsee.ai/ja/docs/argus) でアップロード、タスク、照会、出力を確認します。
- **Pano-to-VR**：[専用ガイド](https://developer.realsee.ai/ja/docs/pano-to-vr) でパノラマから SaaS VR を作成します。

データを変更・タスクを作成する操作もあります。実行前に挙動を確認してください。任意のメタデータは Five SDK Work ではありません。[Five SDK](https://developer.realsee.ai/ja/docs/five-sdk/quickstart) には Work と `parseWork` を使います。

<span id="interpret-the-actual-result" class="docs-anchor-alias" aria-hidden="true"></span>

## 実際の結果を解釈する

HTTP と各エンドポイントの業務応答を確認します。`code`、`status`、`business_code` の意味とデータは API ごとに定義され、業務エラーが HTTP 状態と同じ数値とは限りません。

認証情報の無効・期限切れ、アプリ無効、リソース不足・アクセス不可、入力不正、レート制限を応答に従って処理します。VR がなければ空一覧も正常結果です。調査の相談は [Discord コミュニティ](https://discord.gg/JvxBZJkbNZ) へ。

<span id="next-steps" class="docs-anchor-alias" aria-hidden="true"></span>

## 次のステップ

- [エンドポイントガイド](https://developer.realsee.ai/ja/docs/open-api/reference)：トークン交換、Team リソース、選択 Work。
- [API Reference](https://developer.realsee.ai/api-reference)：全エンドポイントの仕様。
- [開始ガイド](https://developer.realsee.ai/ja/docs/get-started)：認証情報、最初の連携、独立した公開デモ。