Nodaro ドキュメント埋め込み
埋め込み
自社プロダクトに Nodaro を組み込む 2 つの方法（公開済みワークフローを実行するミニアプリと、状態を持たない 3D シーンビューポート）と、それぞれの使いどころを説明します。
埋め込みを使うと、Nodaro の一部を自社プロダクトの中に組み込めます。埋め込みには 2 種類あり、それぞれ異なる課題を解決します。ミニアプリの埋め込みは、ユーザーのために公開済みワークフローを実行し、3D シーンビューポートは、何も実行せずに 3D シーンを表示し、必要に応じて編集もできます。
埋め込みを選ぶ
| ミニアプリ | 3D シーンビューポート | |
|---|---|---|
| できること | 公開済みのミニアプリを実行します。入力を集め、実行を開始し、結果を表示します。 | 3D シーンプランを描画します。ビューポート、再生、オブジェクトの一覧、ポーズエディター、リビジョン履歴です。 |
| 埋め込み方法 | REST API の上に作る独自のインターフェース、またはミニアプリの埋め込みコードによるフレームです。 | postMessage で操作する、/embed/scene3d のフレームです。 |
| 認証 | 独自のインターフェースでは、サーバーに保管した個人用 API トークンまたは OAuth トークンを使います。フレームは、閲覧者自身の Nodaro セッションで動作します。 | 不要です。フレームはセッションを持たず、ネットワーク呼び出しも行いません。 |
| クレジット | 実行のたびにクレジットがかかり、実行の名義となるアカウントが支払います。 | かかりません。ビューアーはジョブを実行しません。 |
| 状態の保存場所 | 実行は Nodaro に保存されます。 | シーンは自分のページが保持します。フレームは、再読み込みをまたいで何も保持しません。 |
ミニアプリを埋め込むタイミング
- ワークフローをミニアプリとして公開していて、自社のサイトやアプリから、ユーザーにそれを実行してもらいたいとき。アプリを参照してください。
- アプリの周りに、独自のフォームとスタイルを用意したいとき。REST API の上に組み立てます。
- 最も手早い方法を使いたいとき。ミニアプリの埋め込みコードを、自分のページに貼り付けます。
ミニアプリを埋め込むを参照してください。
3D シーンビューポートを埋め込むタイミング
- 自分のプロダクトが、3D シーン生成（Generate 3D Scene）や 3D シーン編集（Edit 3D Scene）のジョブによる 3D シーンプランを保存していて、ユーザーがそれを見られるようにしたいとき。
- ユーザーがシーンを再生、スクラブし、シーン内のオブジェクトを選択できるようにしたいとき。デフォルトは読み取り専用です。
- ユーザーがポーズ、色、ロックを編集できるようにし、新しいリビジョンはそのつど自分のページで保存したいとき。
3D シーンビューポートを埋め込むを参照してください。ビューポートが描画するデータについては、3D シーン形式を参照してください。
どちらも、トークンをブラウザーに置かない
どちらの埋め込みも、Nodaro のトークンを Web ページの中に置くことはありません。独自のミニアプリのインターフェースを作る場合、トークンは自分のサーバーに置かれたままです。3D シーンビューポートのメッセージには、トークンが一切含まれません。自分のページが、シーンのアセットを自分のセッションで取得し、そのバイトデータを送ります。
よくある質問
関連ページ
ミニアプリの埋め込み
公開された Nodaro のミニアプリを、埋め込みコードで、または REST API 上に作った独自のフォームで、自分のプロダクトの中で実行します。入力の読み取りから、実行、結果、エラーまでを扱います。
3D シーンビューポートの埋め込み
Nodaro の 3D シーンビューポートを自分のアプリにフレームとして埋め込み、postMessage で操作する方法を、ハンドシェイクや state メッセージから、編集イベント、アセット転送、上限まで説明します。
3D シーン形式
Nodaro の 3D シーンプランがどのように構成されるか、バージョン 1 のプリミティブとキーフレームから、バージョン 2 の GLB アセット、セマンティックエンティティ、カメラトラック、ショット、編集オーバーレイまでを説明します。
アプリ（ミニアプリ）
ミニアプリは、専用の URL を持つシンプルなフォームとして公開したワークフローです。利用者が入力する項目、表示モード、共有、料金、埋め込みを設定できます。
最終更新