セットアップ

RealityConnect APIを呼び出す前に、環境がAPIに到達できることを確認し、アクセスの仕組みを理解し、統合に合ったOAuthフローを選択してください。各フローには専用のステップバイステップガイドがあります。

前提条件

最初のOAuthアプリケーションを作成するには、組織管理者アクセスが必要です。まだお持ちでない場合は、組織管理者がアクセス権を付与するか、アプリケーションを作成してくれます。

API URLとネットワークアクセス

OAuth認証情報を作成する前に、統合を実行するマシンまたはサーバーがHTTPS経由でPrevu3D APIに到達できることを確認してください。企業のファイアウォール、プロキシ、許可リストは、送信トラフィックをブロックし、接続タイムアウトやDNSエラーを引き起こすことがよくあります。

統合は以下に到達できる必要があります：

OAuthおよびAPI検出： https://cloud-api.prevu3d.com
リージョンRealityConnect API（組織は1つのリージョンを使用します。正確なURLの確認方法は各フローガイドで説明しています）：

接続できない場合は、ITチームにこれらのホストへの送信HTTPSアクセスを許可するよう依頼してください。

セキュリティモデル

APIアクセスは3つのレイヤーによって強制されます。リクエストはすべてのレイヤーを通過する必要があり、いずれかのレイヤーがアクセスを拒否すると、リクエストは失敗します。

レイヤー1 — OAuthスコープ。 OAuthアプリケーションで設定します。スコープは、アプリケーションが実行を許可されている操作の種類を定義します（例：read:basic、read:hierarchy）。

レイヤー2 — コンテンツアクセス。 APIを呼び出すアカウントで設定します。Client Credentialsの場合は、OAuthアプリケーションとともに作成されたサービスユーザーです。Authorization Codeフローの場合は、サインインしたユーザーです。このレイヤーは、呼び出し元が表示および操作できるノード（組織、ディビジョン、サイトなど）を決定します。

レイヤー3 — ロール/権限アクセス。 同じアカウントで、ノードごとに設定します。呼び出し元がそのコンテンツに対して実行できる操作（読み取り、編集、管理など）を決定します。

各フローガイドでは、ユースケースに応じてこれらのレイヤーをどこでどのように設定するかを説明しています。

OAuthフローの選択

統合の実行方法に合ったOAuthフローを選び、専用ガイドに従ってください：

フロー	最適な用途	ガイド
Client Credentials	組織の代理で動作するサーバー間統合、スクリプト、バックエンドサービス	Client Credentialsフロー
Native app	ユーザーがブラウザでサインインする統合（デスクトップアプリ、CLI、プラグイン）。Authorization Code + Native Application、PKCE、localhostリダイレクト、クライアントシークレットなし。	ネイティブアプリケーションフロー
Authorization Code + カスタムHTTPSリダイレクト	独自ドメインのコールバックURLを持つWebアプリケーション	近日公開

どこから始めればよいかわからない場合は、Client CredentialsがAPIのテストやサーバーサイドの自動化を構築する最も簡単な方法です。特定のサインインユーザーとしてAPIを呼び出す必要がある場合はNative appを使用してください。

実験的エンドポイント

APIリファレンスの一部の操作は実験的とマークされています。OpenAPIドキュメントではx-scalar-stability: experimentalを宣言しています。

実験的エンドポイントは安定版とは異なる扱いをしてください：

変更を想定する。 パス、パラメータ、ペイロード、レスポンス、エラー、または可用性は、APIの残りの部分と同じ安定性保証なしに変更される場合があります。
使用を分離する。 本番ワークロードでは安定した操作を優先してください。実験的なものに依存する場合は、契約が進化したときに迅速に調整できるよう、小さなアダプターの背後に置いてください。
最新の状態を保つ。 リリースノートをフォローし、アップグレード後にAPIリファレンスを再確認して、動作の変更に驚かないようにしてください。

次のステップ

次のオプションからフローを選び、ガイドを最初から最後まで進めてください。

利用可能なすべての操作を確認するには、APIリファレンスを参照してください。