RealityConnect API (RCAPI)
はじめに Prevu3D RealityConnect APIの概要:機能、リージョナルアーキテクチャ、OAuth2認証、RealityPlatformおよびRealityTwinとの統合方法を解説します。
セットアップ RealityConnect APIの前提条件、ネットワークアクセス、セキュリティモデル。OAuthフローを選択し、専用ガイドに従います。
トークンから目に見える変更まで コピー&ペーストで実行できるClient Credentialsの一連の流れ:トークンを取得し、サイトまで参照し、名前を変更し、Prevu3D Platformで変更を確認してから元に戻します。
OAuthスコープリファレンス RealityConnect APIが付与するすべてのOAuthスコープと、各スコープが許可する操作、新規統合でつまずきやすい注意点を解説します。
ビジネスオブジェクトとノードの検索 RealityConnect APIを使って、twin内のビジネスオブジェクトとメタデータを検索する、または組織のノード階層を検索する方法。
OAuthフロー Client Credentialsフロー、ネイティブアプリケーションフロー、Authorization Code + Custom Redirect Flow
レート制限 RealityConnect APIのレート制限バケット、レスポンスヘッダー、429 Too Many Requestsへの対処方法を解説します。
エラーコード RealityConnect APIの操作が返す名前付きエラーコードのリファレンス。エンドポイントごとのレスポンス形式と推奨される対処方法を解説します。
contextId が受け付ける値 RealityConnect API の twin ルートおよび RealityPlan ルートでパスパラメータ contextId が受け付ける id の種類と、有効な id でも 404 になる理由について説明します。
実運用でのトークンライフサイクル 長期稼働するインテグレーションでRealityConnect API OAuthトークンを安全にキャッシュ・更新する方法。フローごとの実際のTTLと、トークンが早期に無効化される要因を解説。
認証情報の取り扱い RealityConnect APIのOAuth認証情報を安全に保管・ローテーション・失効させる方法と、漏洩したアクセストークンが到達し得る範囲。
削除が実際に何をするか(リソース別) RealityConnect API の各リソースを削除すると実際に何が起こるかのリファレンス:どの削除が復元可能か、何がそれをブロックするか、残された参照はどうなるか。
ノードタイプと階層 RealityConnect APIの10種類のノードタイプ、有効な親子の組み合わせ、APIが作成できるタイプ、DataNodeの構造について解説します。
APIの安定性、バージョニング、非推奨ポリシー RealityConnect APIにおける実験的な操作の見分け方、破壊的変更の定義、および非推奨化ポリシーについて説明します。
POIアイコンリファレンス(textureId) POI(ポイントオブインタレスト)作成時に有効なtextureIdの値と、各アイコンが実際に表す内容の一覧です。
IDを見つける: 組織、ノード、コンテキスト 組織IDを取得し、RealityConnect APIのノードツリーをたどり、各ルートファミリーが必要とするID(contextId、organizationId)を確認します。
共有マルチパートアップロードリファレンス RealityConnect APIのアップロードエンドポイントが共有する開始・アップロード・確定のパターンと、partNumberとstartIndexのパート番号ルールを解説します。
型付きメタデータ値と添付ファイル RealityConnect APIのメタデータプロパティ値のリファレンス:string/number/boolean/タグ付きオブジェクトのユニオン、external-linkとattachmentのセンチネル型、添付ファイルのアップロード・ダウンロード・削除フロー。
ノードのサムネイル データノードのサムネイル画像のアップロード、取得、削除、および browse と search における includeThumbnail と thumbnailSignedUrl の挙動。
ネットワーク要件 企業ネットワークからRealityConnect APIに接続するためのファイアウォール、プロキシ、TLS、Egress要件、および接続診断の手順。
RealityConnect API FAQ プロジェクトが承認される前から出てくる、RealityConnect APIに関する商取引・アーキテクチャ・「これはできるか」といった質問への回答集です。