開始使用 Rapid API
開始使用 Rapid API 非常簡單。只需取得 API 金鑰與共用密碼、進行 Rapid 驗證設定,然後開始執行測試即可。
1. 成為合作夥伴
若要與 Rapid API, 整合,您需要申請成為合作夥伴(若尚未成為合作夥伴)。
2. 查看適用於您網站的啟動條件
查看啟動條件,確認哪些要求需要前端使用者介面開發,並將其納入專案計畫。
3. 準備環境
參考以下資源,為使用 Rapid 準備環境。
4. 取得憑證並進行 Rapid 驗證設定
一旦您成為合作夥伴並獲准與 Rapid API, 整合,您將需要取得您的 API 金鑰。您可以登入 EPS 入口網站,然後按一下左側功能表列中的串接執行此動作。接著在選項中選擇 API 金鑰。入口網站將顯示您當前的 API 金鑰詳細資訊。
API 金鑰是進行簽署驗證所需的兩項關鍵憑證之一。您還需要共用密碼,只要前往 EPS 入口網站並瀏覽至 API 金鑰頁面,即可取得此密碼。在網站審查核准進入生產環境前,API 金鑰會處於有限開發模式。
無論是在測試或實際上線時,如要向 Rapid 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/ 上傳送的任何預訂申請,都不會產生實際的住宿預訂或信用卡費用。您可以從我們所載的測試標頭中選擇要在預訂 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,即可繼續發送請求,無需額外修改程式碼。