API の利用開始
認証と承認により Expedia データを活用する
Expedia Group 旅行プラットフォーム API を使用するには、API クライアントを 1 つ以上作成する必要があります。API クライアントは、パスワードで保護されたユーザーアカウントのようなものです。基本的に、API リクエストを行うソフトウェアがユーザーに属していることを確立 (認証) し、クライアントごとに実行できる API リクエストの種類を制限できます (承認)。
サンドボックス機能をテストする
Fraud Prevention サービスによりサンドボックス機能が実現され、本番アプリケーションに反映されない方法で API 結果をテストできるようになりました。API Explorer、Postman、またはその他のツールでサンドボックス固有のログイン情報を使用して Fraud Prevention サービス API を試し、本番環境にプッシュする前に構成をテストできます。
サンドボックス環境で API をテストする方法の詳細については、Fraud Prevention サンドボックスをお読みください。
API クライアントを作成する
サンドボックスモードで開始する場合でも、最初から本番環境で開始する場合でも、Expedia Group Console で API クライアントを作成および管理できます。API クライアントを作成する前に、アカウントに製品を追加しておく必要があります。
手順 :
- コンソールで、左下隅にある [API クライアントを作成] リンクをクリックします。
- [新しい API クライアントの作成] ページで、自分や組織内の他のユーザーがクライアントに含まれる製品を思い出すのに役立つ名前と説明をクライアントに入力します。
- 利用可能な製品のリストで、含めるスコープの横にあるボックス (API リクエストタイプ) にチェックを入れます。最上位のボックスにチェックを入れると、すべての子要素が選択されます。
- [資格情報を取得] をクリックします。
- ログイン情報をコピーし、安全な場所に保存します。
注 : API ログイン情報はクライアントの作成時にのみ表示されるため、先に進む前にログイン情報をコピーして保存しておく必要があります。この情報を再度表示することはできません。
必要な数だけ API クライアントを作成できます。クライアントごとに異なる権限を付与できるため、Expedia Group 旅行プラットフォーム上で実行できることをソフトウェアサービスごとに制限できます。
製品とスコープ
すべての API クライアントは、単一のパートナーアカウント内で動作します。アカウントに製品を追加すると、API クライアントに含めることができるようになります。単一の API クライアントを作成して、1 つ以上の製品へのアクセス権を付与できます。
各製品には、特定のリクエストタイプへのアクセス権を付与する一連の「スコープ」が含まれます。割り当てるスコープは、そのクライアントに許可される操作を制御します。API リクエストを実行するソフトウェアサービスが複数ある場合は、サービスごとに API クライアントを個別に作成し、各 API クライアントが必要とするスコープのみを選択します。
クライアントのログイン情報
各 API クライアントには、ユーザー名とパスワードに似た認証用の ID とシークレットが付与されます。ログイン情報はクライアントの作成時にのみ表示されるため、先に進む前にログイン情報をコピーして保存しておく必要があります。
**API クライアントのログイン情報を必ず保護してください。**GitHub やクライアント側のコードなど、誰でもアクセスできる場所にクライアント ID またはシークレットを保存しないでください。
検索
API Explorer で API を試すだけの場合は、特別な操作は不要です。[認証セクションを表示] トグルを切り替えて、API Explorer UI で API クライアントキー (client_id) とシークレットを直接入力できます。
ソフトウェアに API クライアントを組み込む方法については、API の認証と承認をお読みください。