Rapid Postman コレクション
以下の Rapid API の Postman コレクションを入手できます。
Rapid Postman コレクション
Postman コレクションには、Rapid へのリクエストが含まれています。
リクエストは、サイト上の Swagger マテリアルに関連付けてグループ化されています。
- 地理
- コンテンツ
- ショッピング
- 提案
- 予約
- 予約管理
コレクションは、可能な限り自己完結型になるように作成されており、リクエストごとに認証ロジックとチェックイン / チェックアウトの自己更新がカプセル化されています。
各コレクションにはいくつかの基本的なテストもあり、Postman コレクションのランナー機能と併用できます。 詳細はこちらをクリックしてください。
前提条件とシステム要件
api_key
およびshared_secret
。- Postman の最新バージョン。
インストール
以下のリンクからコレクションをダウンロードしたら、Postman にインポートします。
api_key
変数と shared_secret
変数が設定されていることも確認する必要があります。詳細については、Postman のサイトを参照してください。
テストに関する注意事項
「コレクションの編集」セクションは編集または変更しないでください。
リクエストを想定どおりに機能させるには、変数とコードが変更されていないことが必要です。
構成
コレクションを使用するには、いくつかの環境変数を設定する必要があります。Postman による変数の処理方法の詳細については、こちらをご覧ください。
次のパラメータを定義できます。必須のパラメータは 2 つのみです。
キー | デフォルト | 必須 | 説明 |
---|---|---|---|
api_key | 該当なし | はい | API キー。 |
shared_secret | 該当なし | はい | 共有シークレット。 |
eanapi_url | https://test.ean.com/ | いいえ | ターゲットにするホスト。https://api.ean.com で上書きできます。 |
property_id | 3609882 | いいえ | コンテンツと空室状況に関するコールでリクエストする LCM / エクスペディアの property_id 。 |
region_id | 178248 | いいえ | 地理に関連するコールでリクエストする地域。 |
iata_airport_code | ORD | いいえ | 地理に関連するコールでリクエストする IATA 空港コード。 |
iata_airport_metro_code | CHI | いいえ | 地理に関連するコールでリクエストする IATA 空港都市コード。 |
language | en-US | いいえ | リクエストするローカライズされた言語。BCP47 形式のサブセット。 |
occupancy | 2 | いいえ | リクエストする 1 室あたりの収容人数。形式は numberOfAdults[-firstChildAge[,nextChildAge]]。たとえば「2-9,3」は、「大人 2 名、9 歳の子供、3 歳の子供」を表します。 |
booking_email | john@example.com | いいえ | 予約リクエストに使用されるメール。 |
hold_itinerary_creation | true | いいえ | 保留状態で旅程を作成するかどうか。 |
billing_terms | 該当なし | いいえ* | 結果として返される予約の請求方法に関する条件。 |
partner_point_of_sale | 該当なし | いいえ* | ショッピングと予約に使用する販売サイト。 |
payment_terms | 該当なし | いいえ* | 結果として返される予約の支払いを受けるときに使用する支払い条件。 |
platform_name | 該当なし | いいえ* | ショッピングと予約に使用するプラットフォーム。 |
*必須ではない変数のうちアスタリスクが付いているものは、api.ean.com にのみ必要で、test.ean.com には不要です。
次のパラメータは自動生成され、環境に設定されることにご注意ください。
キー | グローバル | 説明 |
---|---|---|
authorizaton | はい | この承認コードは api_key および shared_secret から生成され、リクエストヘッダーとして使用されます。 |
checkin | はい | checkin の日付は、空室状況のリクエストに対して自動生成されます。この日付は常に、リクエストの作成日から 30 日後になります。 |
checkout | はい | checkout の日付は、空室状況のリクエストに対して自動生成されます。この日付は常に、リクエストの作成日から 32 日後になります。 |
arrival | はい | arrival の時間は、クロスセルのリクエストに対して自動生成されます。この時間は常に、リクエストの作成時間から 30 日後になります。 |
affiliate_reference_id | いいえ | affiliate_reference_id は予約作成リクエストで使用され、後続の予約を取得するために使用できます。 |
price_check_link | いいえ | price_check_link は、空室状況、クロスセル、または提案のリクエストに続いて設定されます (返された宿泊施設にそのリンクがある場合)。料金チェックリクエストを行うために使用できます。 |
payment_options_link | いいえ | payment_options_link は、空室状況、クロスセル、または提案のリクエストに続いて設定されます (返された宿泊施設にそのリンクがある場合)。支払いオプションリクエストを行うために使用できます。 |
deposit_policies_link | いいえ | deposit_policies_link は、空室状況、クロスセル、または提案のリクエストに続いて設定されます (返された宿泊施設にそのリンクがある場合)。デポジットポリシーリクエストを行うために使用できます。 |
book_link | いいえ | book_link は、料金チェックリクエストに続いて設定されます (返された宿泊施設にそのリンクがある場合)。予約リクエストを行うために使用できます。 |
retrieve_link | いいえ | retrieve_link は、予約リクエストに続いて設定されます (返された旅程にそのリンクがある場合)。取得リクエストを行うために使用できます。 |
resume_link | いいえ | resume_link は、予約リクエストに続いて設定されます (返された旅程にそのリンクがある場合)。再開リクエストを行うために使用できます。 |
cancel_link | いいえ | cancel_link は、予約リクエストに続いて設定されます (返された旅程にそのリンクがある場合)。キャンセルリクエストを行うために使用できます。 |
cancel_room_link | いいえ | cancel_room_link は、予約リクエストに続いて設定されます (返された旅程にそのリンクがある場合)。客室キャンセルリクエストを行うために使用できます。 |
change_room_link | いいえ | change_room_link は、予約リクエストに続いて設定されます (返された旅程にそのリンクがある場合)。客室変更リクエストを行うために使用できます。 |
complete_payment_session_link | いいえ | complete_payment_session_link は、予約リクエストに続いて設定されます (返された旅程にそのリンクがある場合)。これを使用して、支払いセッション完了リクエストを作成できます。 |
pagination_link | いいえ | pagination_link は、改ページ処理されたエンドポイントに対して行われたリクエストに続いて設定されます。これを使用して、API で改ページ処理がどのように機能するかを実演できます。 |
推奨構成
eanapi_url
、api_keyshared_secret
のみが設定されている環境で変数を定義することを推奨します。
Rapid Postman コレクション
以下のコレクションをダウンロードする前に、上記の情報を必ずお読みください。