組織内で使用可能なすべての API は、Cloud Services コンソールの [API エクスプローラ] 画面から直接試用することができます。

前提条件

組織内での組織の所有者ロールが必要です。

手順

  1. Cloud Services コンソール のテナントにログインします。
  2. [デベロッパ センター] > [API エクスプローラ] の順に移動します。
  3. [API エクスプローラ] 画面の [使用可能な API] メニューから API カテゴリを選択します。
    画面が更新され、選択したカテゴリで使用可能なすべての API が表示されます。
  4. 矢印アイコンを使用して、API の内容を展開します。
  5. [試してみる] セクションまで下にスクロールします。
    API の [試してみる] セクションの例。
  6. API 呼び出しを作成するには、必要なプロパティを入力します。
    プロパティは、画面の右側に表示される環境の詳細に基づいて、可能な場合は事前に入力されます。
    API 統合またはサーバ呼び出しをローカルで構築または使用する場合は、API 仕様のサンプルのスニペットを使用する場合があります。これを容易に行うには、 [API エクスプローラ] 画面の上部と下部にある [API/Swagger の仕様をダウンロード] ボタンをクリックします。仕様ファイルには、サンプルの呼び出しと予期される応答が含まれています。
  7. [実行] をクリックします。
    注： [API エクスプローラ] から行ったすべての API 呼び出しは、稼動中の環境に対して実行されます。 [試してみる] 機能を使用する際は、常に注意が必要です。

結果

API 呼び出しを実行すると、画面が更新され、[API エクスプローラ] ページの [試してみる] セクションの下に応答が表示されます。モデルの応答の操作、ペイロードのテキスト形式での表示、応答のコピーまたはダウンロードが可能です。

例:

この例では、[ID とアクセスの管理] カテゴリの API を使用して、現在組織にログインしているユーザーであるプリンシパル ユーザーに関する情報を取得します。

  1. [API エクスプローラ] を開きます。
  2. [使用可能な API] リストから [ID とアクセスの管理] を選択します。
  3. 表示される [API カテゴリ] のリストで、[プリンシパル ユーザー] をクリックします。
  4. GET /am/api/loggedin/user をクリックします。
  5. [実行] をクリックします。

作成した API 呼び出しに対する応答が画面の [応答] セクションに表示され、組織へのログインに使用したユーザー情報が返されます。