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

k-ID APIリファレンスには、ドキュメントから直接APIエンドポイントをテストできるインタラクティブなコードサンプルが含まれています。各エンドポイントページには、コードサンプルとライブAPI呼び出しを行うために使用できるリクエストインターフェースが含まれています。

インタラクティブリクエストインターフェース

すべてのエンドポイントページには、「リクエスト」セクションにインタラクティブなリクエストインターフェースが含まれています。このインターフェースでは、以下を行うことができます：

1. ベースURLを選択: ベースURLフィールドにマウスをホバーして、編集ボタンを表示します。編集ボタンをクリックして、利用可能なベースURLを含むドロップダウンメニューを開きます：

   • ライブ: https://game-api.k-id.com/api/v1/
   • テスト: https://game-api.test.k-id.com/api/v1/

2. リクエストを認証: APIキーを「Bearer Token」フィールドに貼り付けます

   • APIキーはCompliance Studioから取得できます
   • 選択した環境（テストまたはライブ）に正しいAPIキーを使用していることを確認してください

3. リクエスト本文を設定: 本文フィールドには、サンプル値を含むサンプルリクエストが含まれています

   • リクエスト本文の値を必要に応じて変更できます
   • 必須フィールドはエンドポイントドキュメントで示されています

4. リクエストを送信: 「Send API Request」をクリックしてAPI呼び出しを完了します

5. レスポンスを表示: レスポンスはリクエストインターフェースの下に表示され、リクエストに対するAPIのレスポンスが表示されます

コードサンプル

各エンドポイントページには、右上にさまざまなプログラミング言語とツールでリクエストを行う方法を示すコードサンプルも含まれています。これらのサンプルは参考用であり、自分のコードで使用するためにコピーできます。

ベストプラクティス

• APIを実験する際はテスト環境を使用する
• APIキーをバージョン管理にコミットしない - 代わりに環境変数を使用する
• レスポンスを慎重に確認してAPIの動作を理解する
• リクエストが失敗した場合はエラーレスポンスを確認して、何が間違っていたかを理解する

認証とAPIキーの詳細については、認証を参照してください。