サンドボックスモード

サンドボックス機能でエクスペディアの API を安全にテストする

無料のサンドボックス機能を使用すると、エクスペディアの API 製品をテストできます。サンドボックスで行った作業は本番アプリケーションには反映されず、その逆も同様です。

サンドボックス機能では以下を行うことができます。

• 安全でリスクのない方法でサンドボックス対応製品を試す
• サンドボックス専用 API クライアントを作成する
• 必要に応じてサンドボックス製品の設定を更新する
• API Explorer、Postman、または他のツールでサンドボックスエンドポイントをテストする

サンドボックスモードへのアクセス

Expedia Group Console にログインし、アカウントを選択します。初めてサンドボックス機能にアクセスすると、アクセス元のパートナーアカウントと同じ情報でサンドボックスアカウントが作成されます。

次の 2 通りの方法でサンドボックスモードに切り替えることができます。

1. グローバルトグルを使用する

左下隅にあるアカウント名をクリックして、パートナーアカウントメニューに移動します。

アカウントのポップアップで、「Sandbox mode (サンドボックスモード)」トグルをクリックしてオンにします。

サンドボックスモードでは、本番アプリケーションに影響を与えることなく変更を加えることができます。製品カタログにはサンドボックス対応製品のみが表示されます。

本番モードに戻る準備ができたら、アカウントのポップアップのトグルを再度オフにします。

2. 製品詳細ページから製品を試す

製品カタログにアクセスして、興味のある製品を見つけます。サンドボックスに対応した製品にはバッジが表示されます。

サンドボックス対応製品の製品カードをクリックすると、製品詳細ページが表示されます。ページの上部にある「製品を試す」ボタンをクリックしてサンドボックスモードに切り替え、テストを設定します。

本番モードに戻る準備ができたら、「Go to live mode (本番モードに戻る)」リンクをクリックするか、アカウントのポップアップに戻ってグローバルトグルを切り替えます。

サンドボックス上で製品を設定する

初期設定

サンドボックス対応製品の製品詳細ページで「Try product (製品を試す)」をクリックして、サンドボックスモードで設定を表示します。

更新

1. グローバルトグルを使用してサンドボックスアカウントを開きます。
2. 更新する製品の製品詳細ページに移動します。
3. コンテキストメニュー (右上隅にある 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 の公開

サンドボックステストが完了したら、本番アプリケーションで使用する API クライアントの本番バージョンを作成できます。

1. コンソールにログインします。
2. 製品カタログで、追加する製品の製品詳細ページに移動します。
3. 「Add product (製品を追加」をクリックします (製品に承認が必要な場合は「Request to add (追加をリクエスト)」をクリック)。
4. サンドボックスで行ったように製品を設定します。
5. 「送信」をクリックします。
6. 本番 API クライアントの作成 : 左側のナビゲーションで「API クライアントを作成」をクリックします。
7. 通常はサンドボックスと同じスコープを使用します。
8. 「Get credentials (ログイン情報を取得)」をクリックします。

注 : 製品を追加する際、追加情報が求める連絡がエクスペディアチームから来る場合があります。

サンドボックスから直接本番環境への移行をリクエストすることもできます。「Go to live mode (本番モードに戻る)」リンクを探してください。

ソフトウェアに API クライアントを組み込む方法については、「API の認証と承認」をお読みください。