ポストマンコレクション
Rapid APIのエンドポイントをテストし、Postmanで具体的なリクエスト/レスポンス形式を確認します。
現在利用可能
今現在、ポストマンコレクションを提供しています:
- Rapid Lodging API (通知サービスを除く)
- ラピッドカーAPI
まだ一般公開されていないRapid Flight APIとActivities APIのコレクションが追加される予定です。
注: これらのリクエストは、サイト上のSwagger素材に関連してグループ化されています。
コレクションは可能な限りself-containedになるように書かれています - 認証ロジックと各リクエストのcheck-in/check-out self-updateをカプセル化しています。各コレクションには、Postmanコレクションランナー機能と組み合わせて使用できる基本的なテストもあります。
インストール
Download Postman collections セクションからコレクションをダウンロードし、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 | 該当なし | -* | ショッピングAPIと予約APIに使用される販売ポイント。 |
payment_terms | 該当なし | -* | 結果として返される予約の支払いを受けるときに使用する支払い条件。 |
platform_name | 該当なし | -* | ショッピングと予約に使用するプラットフォーム。 |
* 注:これらの変数は**# でのみ必要です。api.ean.com**** では必要ありません。test.ean.com**.
以下のパラメータはauto-generated、お使いの環境で自動的に設定されます:
| キー | グローバル | 説明 |
|---|---|---|
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 のみを設定した環境で変数を定義することをお勧めします。
ポストマンのコレクションをダウンロード
これらのコレクションをダウンロードする前に、このページの説明を必ずお読みください。