[このトピックはプレリリース ドキュメントであり、変更されることがあります。]
API プレイグラウンドは、メーカーが迅速かつ便利に Microsoft Dataverse Web API と対話できるようにする、事前認証されたソフトウェア テスト ツールです。
この Web アプリケーションを使用すると、開発者は大規模なセットアップや認証プロセスを必要とせずに、さまざまな API エンドポイントをテストおよび実験できます。 また、利用可能な特定のアクションとドキュメントへのリンクも表示され、学習のスピードを上げることができて便利です。
このツールを使用して、RESTful API で何ができるかを調べたり、ユーザー定義のワークフローをテストしたりします。
重要
- これはプレビュー機能です。
- プレビュー機能は運用環境での使用を想定しておらず、機能が制限されている可能性があります。 これらの機能を公式リリースの前に使用できるようにすることで、顧客が事前にアクセスし、そこからフィードバックを得ることができます。
主な機能
- 事前認証済み: API プレイグラウンドは事前認証済みなので、開発者はすぐに API エンドポイントのテストと実験を開始できます。
- Web ベース: API プレイグラウンドを使用すると、ソフトウェアのダウンロードやマイクロソフト以外のアカウントなどの大規模な設定を必要とせずに、開発者は Dataverse Web API と素早く対話することができます。 このツールには、Dataverse アクセラレータからアクセスできます。これはマイクロソフトのアプリで、すべての新しい Dataverse 環境に対応しており、あらゆる環境でインストールできます。
- 便利: Dataverse Web API で使用できるさまざまなアクションと機能を説明し、可能なことと実装方法をすぐに簡単に学習できます。
前提条件
Dataverse へのアクセス権 および Dataverse アクセラレータ アプリをプレイするためのアクセス権が必要です。 システム カスタマイザー セキュリティ ロールのメンバーは、アプリを使用するためのアクセス権があります。
概要
API プレイグラウンドの使用を開始するには、Dataverse アクセラレータをプレイして、API プレイグラウンド ページを選択します。
Dataverse Web API 要求を行う
ランディング画面で、一番上のカードのいずれかにある 作成を選択し、要求タイプを選択して要求エディターを開きます。
3 つの要求タイプが提示されます。
| タイプ | 説明 |
|---|---|
| カスタム API | これには、マイクロソフトのすべての Dataverse Web API アクション、関数、または作業環境に登録されているすべてのパブリック ユーザー定義のカスタム API が含まれます。 |
| インスタント プラグイン | インスタント プラグイン は、関連する FxExpression を使用して環境内でカスタム API として登録されたユーザー定義のワークフローとして分類されます。 |
| OData 要求 | OData 要求を送信するための要求入力をより細かく制御できます。 |
カスタム API またはインスタント プラグインを要求する
これらの要求タイプは、作業環境で使用可能なプラグインの呼び出しを簡素化するように設計されています。
現在の環境で使用可能なプラグインを表示するメインのドロップダウン リストからオプションを選択します。
パラメーターが使用可能な場合は、表示される クエリ パラメーター テーブルに表示されます。 必要なパラメーターの値を指定します。
注意
各パラメーターの左側にあるチェックボックスは、そのパラメーターが要求に含まれているかどうかを示します。 必須パラメーターには無効なチェックボックスがあり、オプションのパラメーターには編集可能なチェックボックスがあります。
送信を選択します。
画面の下部に表示される 応答 を確認します。
注意
インターフェイスには、環境内で利用可能なすべてのプラグインの便利なリストが表示されます。 選択すると、データ型に関連付けられたパラメーターが表示されます。 舞台裏では OData 呼び出しがまだ行われていますが、インターフェイスによって呼び出しの構築が簡素化されています。
OData 要求を行う
OData 要求では、要求パラメーターにさらに多くのオプションを使用できます。
最初のドロップダウン リストで HTTP 要求メソッド を選択します。
エンドポイント URL を入力します。
[OrgUrl]/api/data/v9.2/の後に要求 URL のみを含めます次の 2 つの方法のいずれかを使用して、クエリ パラメーター を追加します。
URL 内で。
URL 内の疑問符 (
?) 文字の後に、クエリ パラメーター キーを入力します。
キーの後に等号 (
=) を入力します。値に入力します。
キーと値は、インターフェースのパラメーター テーブルに自動的に入力されます。
+ パラメーターの追加 を選択して、クエリ パラメーターを手動で追加します。 これにより、値を入力できる空のパラメーター行がテーブルに追加されます。 値が入力されると URL は動的に更新されます。
必要に応じて、本文 タブを選択して本文を指定し (GET 以外のすべての要求メソッドを使用する場合)、エディター コントロールに本文の値を入力します。
送信を選択します。
セクションの下部に表示される 応答 を確認します。
応答を表示する
要求が送信されると、応答が画面の下半分に表示されます。
応答ステータスは、要求に関する簡単なメトリックを提供します。
- 状態メッセージ
- 期間 (ミリ秒)
- サイズ (キロバイト)
応答本文は、応答ステータスの下に表示されます。 コピー アイコンを選択すると、応答の本文がクリップボードにコピーされます。
よくあるご質問
API プレイグラウンド ツールにアクセスするにはどのような権限が必要ですか?
ツールを使用するには、Dataverse アクセラレータ アプリへのアクセス権が必要です。
API プレイグラウンド ツールは、Dataverse Web API にのみ接続しますか?
はい、API プレイグラウンド ツールは、Dataverse Web API にのみ接続します。 このインターフェースでは、接続できる他のサービスはありません。
API プレイグラウンド ツールは、どのように Dataverse Web API を承認しますか?
このツールは、Dataverse アクセラレータ アプリケーションを再生するために必要な、ログインしたユーザーの認証トークンを使用します。
API プレイグラウンド機能は、すべての環境で使用できますか?
この機能は Dataverse アクセラレータを通じて提供され、このアプリがインストールされているすべての環境で利用できます。 このアプリはすべての新しい環境に自動的にインストールされていますが、インストール手順に従って古い環境にもインストールできます。