API の概要

Designer バージョン r21 で、API から各種の操作を実行できる機能が導入されました。

Designer バージョン r23.2 で新しい API がリリースされ、それに合わせて新しい API スイートを詳しく解説する新しいドキュメントポータルが公開されました。

API の初回リリース以降、新しい API の追加や既存 API の更新を行ってきました。Designer API、RenderStream SDK、SMC API などは Developer Portal に記載されています。

API とは？

API（Application Programming Interface）は、あるソフトウェアアプリケーションが別のアプリケーションとやり取りするための一連のルールとプロトコルです。プログラムが情報を要求・交換するために使用できるメソッドとデータ形式を定義します。つまり API は、異なるソフトウェアシステム同士が通信するための橋渡しの役割を果たします。

Disguise の API は、外部・仮想・物理インターフェースから Designer プロジェクトに対して呼び出しを行い、変更やイベントをトリガーするために使用します。呼び出しコマンドを実行するには、既存の特定の Designer プロジェクトとその中の項目への参照を指定する必要があります。これは、操作したいオブジェクトの Unique Identifier（UID）を参照することで行います。

API に対する Disguise のアプローチ

Developer Portal は、包括的な HTTP API を使用した Disguise メディアサーバーと Designer ソフトウェアの制御・監視をサポートします。

HTTP API とは、2 つのシステム間の通信プロトコルとして Hypertext Transfer Protocol を使用する API です。HTTP API は、サーバーへアクセスするための HTTP リクエストの API ゲートウェイとしてエンドポイントを公開します。Disguise の API は通常、情報の取得に GET リクエスト、データの変更やアクションの実行に POST リクエストを使用します。

Workflow Centric

Disguise のワークフローを補完し、統合するように設計された API と SDK。

Developer Focused

Developer Portal は、開発者体験を念頭に設計されています。

Integration Support

Disguise は製品との連携をサポートしています。連携に関するサポートやパートナーシップについては integrations@disguise.one までお問い合わせください。

d3Manager の OpenAPI ドキュメント

Disguise Designer API のドキュメントは、Designer 内にもホストされています。

d3Manager から API ドキュメントにアクセスするには、Help > Open API Documentation に移動します。

このドキュメントは OpenAPI 形式を使用しているため、ドキュメント内から API を実行できます。

API ドキュメントを開く

Designer は d3 API に OpenAPI 形式（Swagger Docs）を使用します。

d3 API

API にアクセスするには、d3Manager を開き、Help をクリックして Open API Documentation を選択します。

Open API Documentation

API の構成

API はデフォルトで TCP ポート 80 を使用します。これは d3Manager で変更できます。

d3Manager を開きます。
Machine Settings > Advanced Network Configuration を選択します。
API http port で指定されているポートを変更します。

API を完全に無効化してポートを一切開かないようにするには、ポートを 0 に設定します。

UID とは？

一意識別子（UID）は、特定のシステム内の単一のエンティティに関連付けられた数値または英数字の文字列です。

Designer 内のすべての項目には数値の UID が割り当てられています。API の GET リクエストは通常、オブジェクトの UID とファイル名を含む Locator を返します。UID は多くの POST リクエストで、変更対象のオブジェクトを一意に識別するために使用できます。

UID は、10 進数または 16 進数を含む文字列として指定します。たとえば、次のクエリの抜粋は同じオブジェクトを参照しています。

"uid" : "2276480868532234653"
"uid" : "0x1F97AF49E2D6299D"

詳しくは、Disguise Developer Portal の Locator を参照してください。

Disguise Developer Portal のリンク

API に関する追加情報は https://developer.disguise.one をご覧ください。次のトピックを扱っています。