Rapid API の利用を開始する
Rapid APIを使い始めるのは簡単です。API キーと共有シークレットを取得し、Rapid 認証の構成を行い、テストを開始するだけです。
1. パートナーになる
Rapid API, と統合するには、まだパートナーでない場合は、 パートナーになることを申請する必要があります。
2. お使いのウェブサイトに該当するリリース要件を確認する
リリース要件を確認し、どの要件にフロントエンド UI の開発が必要かを判断し、プロジェクト計画に反映させます。
3. 環境を用意する
以下のリソースを参考にしながら、Rapid を使用するための環境を用意します。
4. ログイン情報を取得して Rapid 認証を設定する
パートナーになり、Rapid API, との統合が承認されたら、APIキーを取得する必要があります。これを行うには、EPS Portal にログインし、左側のメニュー バーで **サイトコントローラー ** をクリックします。次に、オプションから API キーを選択します。ポータルには、現在のAPIキーの詳細が表示されます。
APIキーは、署名認証に必要な2つのキー認証情報のうちの1つです。共有シークレットも必要です。EPS ポータルにアクセスし、API キーページに移動することで共有シークレットにアクセスできます。サイトのレビュー後、本番環境へのリリースが承認されるまで、API キーは制限された開発モードになります。
テストかプロダクションかを問わず API サービスにリクエストする際は、HTTP 認証ヘッダーを使用して各リクエストの API キーと SHA-512 シグネチャハッシュを送信します。SHA-512 ハッシュは、共有シークレット、API キー、現在の UNIX タイムスタンプで構成されています。Rapid APIの認可ヘッダーは常に以下の形式を使用します:
Authorization: EAN APIKey=yourAPIKey,Signature=sha512Hash,timestamp=yourUNIXTimestamp詳しくは署名認証のページをご覧ください。シグネチャ生成ツールを使用して、統合テストのための SHA-512 ハッシュ値を生成できます。
5. リクエストのテストを開始する
認証情報を受け取り、認証を設定したら、テスト用のエンドポイントであるhttps://test.ean.com/.https://test.ean.com/ に対して予約をリクエストしても、実際の宿泊施設予約やクレジットカードの請求は実行されません。Booking API 用に記載されたテストヘッダーを選択して、表示する応答タイプを指定できます。予約関連のリクエストからテストヘッダーを省略した場合は、テストサーバーによって自動的にヘッダーが追加されます。
重要: 安定して維持可能なサービスを提供するため、料金制限 が適用されます。システムは異常な API トラフィックを監視し、システム自体を保護するためのアクションを自動的に実行します。API 呼び出しの動作に計画的な変更を加える前、または API アクセスを使用してパフォーマンステストを実施する前に、Rapid コンサルタントと計画を確認してください。
API バージョンの指定
OpenAPI 仕様の servers.url 値を使用して URL を構築します。test.ean.com は統合の検証用で、api.ean.com は本番エンドポイントです。エンドポイント間を切り替えるときにプロトコルとパスを保持します。
https://test.ean.com/v3/itineraries?… https://api.ean.com/v3/properties/22135/payment-options?token=U1dFC0JHTWservers.url 値はダウンロード可能な OpenAPI 仕様ファイルの先頭にあり、特定の API サービスのバージョン番号に常に対応しています。
例 : OpenAPI 仕様
openapi: 3.0.1
info:
title: Rapid
description: EPS Rapid V3
version: v3
servers:
- url: https://test.ean.com/v36. サイトの審査を依頼する
統合が完了し、該当する起動要件が満たされていることを確認したら、ビジネスディベロップメントマネージャーにサイトの審査を依頼します。プロダクションへの移行が許可されると、ビジネスディベロップメントマネージャーが API キーを有効にし、プロダクションで使用できるようになります。リクエストエンドポイントをhttps://test.ean.com/ からhttps://api.ean.com に切り替えるだけで、リクエストは継続されます。