サンドボックスの利用を開始する
サンドボックスモードにアクセスして設定し、API を安全にテストする
サンドボックス機能へのアクセス
Expedia Group Console にログインし、アカウントを選択します。初めてサンドボックス機能にアクセスすると、アクセス元のパートナーアカウントと同じ情報でサンドボックスアカウントが作成されます。
次の 2 通りの方法でサンドボックスモードに切り替えることができます。
1. グローバルトグルを使用する
左下隅にあるアカウント名をクリックして、パートナーアカウントメニューに移動します。
アカウントのポップアップで、「Sandbox mode (サンドボックスモード)」トグルをクリックしてオンにします。
製品カタログに移動して、試したい製品を追加します。注 : サンドボックスモードでは、サンドボックス対応製品のみが製品カタログに表示されます。
製品が追加されたら、サンドボックス専用 API クライアントを作成し、API Explorer、Postman、またはその他のツールでそれらのログイン情報を使用して、結果が期待どおりであることを確認できます。サンドボックスモードでは、作成した API ログイン情報は本番アプリケーションに影響を与えないため、本番運用を開始する前に構成を微調整できます。
本番モードに戻る準備ができたら、アカウントのポップアップのトグルを再度オフにします。
2. 製品詳細ページから製品を試す
製品カタログにアクセスして、興味のある製品を見つけます。サンドボックスに対応した製品にはバッジが表示されます。
サンドボックス対応製品の製品カードをクリックすると、製品詳細ページが表示されます。ページの上部にある「製品を試す」ボタンをクリックして、サンドボックスモードに切り替えます。サンドボックスアカウントを Expedia Group アカウントと一致するように構成するように求められます。
試したい製品用にサンドボックス専用 API クライアントを作成し、API Explorer、Postman、またはその他のツールでログイン情報を使用して、結果が期待どおりであることを確認します。サンドボックスモードでは、作成した API ログイン情報は本番アプリケーションに影響を与えないため、本番運用を開始する前に構成を微調整できます。注 : サンドボックスモードでは、サンドボックス対応製品のみが製品カタログに表示されます。
本番モードに戻る準備ができたら、「Go to live mode (本番モードに戻る)」リンクをクリックするか、アカウントのポップアップに戻ってグローバルトグルを切り替えます。
サンドボックス上で製品を設定する
初期設定
サンドボックス対応製品の製品詳細ページで「Try product (製品を試す)」をクリックして、サンドボックスモードで設定を表示します。
更新
- グローバルトグルを使用してサンドボックスアカウントを開きます。
- 更新する製品の製品詳細ページに移動します。
- コンテキストメニュー (右上隅にある 3 つの縦に並んだ点) を開き、「設定を変更」を選択して設定フローを表示します。
注 : このコンテキストメニューは本番アカウントでも使用できるため、エラーを避けるために必ずサンドボックスアカウントに切り替えてください。サンドボックスの選択肢を使用して本番設定を手動で更新する必要があります。
API クライアントの作成
Expedia Group 旅行プラットフォーム API を使用するには、サンドボックスモードか本番モードで API クライアントを 1 つ以上作成する必要があります。API クライアントは、パスワードで保護されたユーザーアカウントのようなものです。基本的に、API リクエストを行うソフトウェアがユーザーに属していることを確立 (認証) し、クライアントごとに実行できる API リクエストの種類を制限できます (承認)。次の 2 通りの方法で API クライアントを作成できます。
- 製品詳細ページのコンテキストメニューをクリックし、「API クライアントを作成」を選択します。
- 左側のナビゲーションで「API クライアントを作成」をクリックします。
「API クライアントを作成」ページで、自分や組織内の他のユーザーがクライアントに含まれる製品を思い出すのに役立つ名前と説明を入力します。利用可能な製品のリストで、含めるスコープ (API リクエストタイプ) を選択します。注 : 最上位のボックスにチェックを入れると、すべての子要素が選択されます。
「作成」をクリックします。
API クライアントが作成されると、ログイン ID とシークレットを含む確認画面が表示されます。**これらは一度だけ表示されます。ログイン情報とシークレットを必ずコピーし、安全な場所に保存してください。**GitHub やクライアント側のコードなど、誰でもアクセスできる場所にクライアント ID またはシークレットを保存しないでください。
製品とスコープ
すべての API クライアントは、単一のパートナーアカウント内で動作します。アカウントに製品を追加すると、API クライアントに含めることができるようになります。単一の API クライアントを作成して、1 つ以上の製品へのアクセス権を付与できます。
各製品には、特定のリクエストタイプへのアクセス権を付与する一連の「スコープ」が含まれます。割り当てるスコープは、そのクライアントに許可される操作を制御します。API リクエストを実行するソフトウェアサービスが複数ある場合は、サービスごとに API クライアントを個別に作成し、各 API クライアントが必要とするスコープのみを選択します。
サンドボックス API クライアントの表示と調整
サンドボックス製品用の API クライアントを作成したら、Developer Hub でテストする製品の API Explorer ページに移動します。サンドボックスをポイントするように API サーバーの URL を変更し、安全なログイン情報を接続します。
API Explorer、Postman、またはその他の API ツールを使用すると、API クライアント設定が返す結果を確認できます。これを早い段階で使用して当社の API が適切であることを確認し、当社の製品のいずれかを本番アプリケーションにプッシュする前に設定の変更をテストしてください。
API の公開
サンドボックステストが完了したら、本番アプリケーションで使用する API クライアントの本番バージョンを作成できます。
- コンソールにログインします。
- 製品カタログで、追加する製品の製品詳細ページに移動します。
- 「Add product (製品を追加」をクリックします (製品に承認が必要な場合は「Request to add (追加をリクエスト)」をクリック)。
- 製品を設定します。多くの場合、本番設定ではサンドボックステストで使用した多くまたはほとんどの設定がそのまま使用されます。
- 「送信」をクリックします。
- 本番 API クライアントの作成 : 左側のナビゲーションで「API クライアントを作成」をクリックします。
- 通常はサンドボックスと同じスコープを使用します。
- 「Get credentials (ログイン情報を取得)」をクリックします。
注 : 製品を追加する際、追加情報が求める連絡がエクスペディアチームから来る場合があります。
サンドボックスから直接本番環境への移行をリクエストすることもできます。「Go to live mode (本番モードに戻る)」リンクを探してください。
ソフトウェアに API クライアントを組み込む方法については、「API の認証と承認」をお読みください。