インタラクティブリファレンス

API → Endpoints 配下のすべてのエンドポイントページには、ライブのリクエストパネルが用意されています。環境を選び、認証し、リクエストを入力して送信すると、呼び出しはブラウザから直接k-ID APIへ送られ、レスポンスがそのページに表示されます。

環境を選択する

パネル上部の Server URL 行は、リクエストの送信先となる環境を示します。初期状態はテストモードです。

変更するには、行の右端にある編集アイコンをクリックし、Server URL ダイアログで選択します。選択内容はブラウザに記憶され、他のすべてのエンドポイントページにも引き継がれます。

認証する

Authorization セクションを開きます。ここには Authorization (Header) というフィールドが1つあり、Bearer があらかじめ入力されています。残りがプロダクトのAPIキーです。

アクセス権のあるプロダクトのキーを使う

ナビゲーションバーの Sign in ボタンから、Compliance Studio と同じアカウントでサインインします。すると Authorization フィールドの上に Use a product's test key ドロップダウンが表示され、アクティブな組織内でアクセスできるプロダクトが一覧されます。1つ選ぶと、そのプロダクトのテストモードキーがフィールドに入力されます。Compliance Studioからキーをコピーしてくる必要はありません。

このリストの作られ方から、次のことが言えます。

• テストモードキーのみです。 ライブキーがドキュメントサイトに送られることはありません。ライブモードを呼び出すには、ライブキーをご自身で貼り付けてください。
• 組織に追従します。 複数の組織に所属している場合は、ナビゲーションバーの組織スイッチャーを使用してください。ページが再読み込みされ、切り替え先の組織でリストが作り直されます。
• プロダクトのアクセス権に追従します。 Developerロールのメンバーは特定のプロダクトに限定できます。その場合、ドロップダウンにはそのプロダクトのみが表示されます。開発者向けのプロダクト単位アクセスを参照してください。
• テストキーのないプロダクトは除外されます。 テストモードキーがまだないプロダクトは、Compliance Studioの Developer Settings ページで生成してください。どのプロダクトにもテストキーがない場合、ドロップダウン自体が表示されません。

自分でキーを貼り付ける

Authorizationフィールドにキーを直接入力または貼り付けることも常に可能です。サインアウトしている場合はこれが唯一の方法であり、ライブモードではこちらを使います。キーはCompliance Studioのプロダクトの Developer Settings ページで取得し、Server URL行で選択した環境と一致していることを確認してください。テストキーはライブモードでは認証されず、その逆も同様です。

リクエストを入力する

パネルの残りのセクションが、リクエストの他の部分にあたります。

• POSTエンドポイントでは Body、GETエンドポイントでは Query — フィールドごとに入力欄があり、サンプル値があらかじめ入っています。必須フィールドには赤いアスタリスクが付き、任意フィールドには解除用の × が付きます。ネストされたオブジェクトはその場で展開されます。
• Header — Kid-Target-Product-Id などの任意ヘッダーを受け付けるエンドポイントで表示されます。

生のJSONとして入力するほうが扱いやすい場合は、Bodyセクションの Open JSON Editor でフォームとJSONテキストエリアを切り替えられます。

送信してレスポンスを読む

Send をクリックします。結果はステータスコードとボディとともにパネル上部に表示され、Close で閉じてリクエストを調整し、再送信できます。

パネルの下にあるフィールドリファレンス（Authorization、Header Parameters、Body、Response Body）には、そのエンドポイントが返しうるすべてのフィールドとステータスコードが記載されています。エラー形式についてはエラー処理を参照してください。

自分のコードにコピーする

レスポンスのドキュメントの下には、コードサンプルのタブ（cURL、JavaScript、Go、Python、Java、C#、Rust）があります。これらはパネルの現在の内容から生成されます。リクエストを目的の形に入力してから、使用する言語のサンプルをコピーすれば、URL、ヘッダー、ボディがそのまま反映されています。