API Postman 指南

Postman 提供簡單易用的介面，可建構、傳送及分析 HTTP 要求，大幅提升測試及瞭解 Merchant API 的能力。您可以輕鬆製作及修改各種 API 呼叫 (GET、POST、PUT、DELETE) 至不同端點，並調整參數、標頭和要求主體，模擬實際情況。

這項工具會清楚呈現回應內容，包括狀態碼、標頭和酬載，方便您快速驗證 API 行為，並協助偵錯。這種結構化做法可加速開發生命週期、提升 API 品質，並深入瞭解 Merchant API 的功能和複雜性。

總覽

如要在 Postman 執行個體上使用 MAPI Postman 集合，請先按照幾個步驟設定環境。以下是逐步操作說明。

如要進一步瞭解這個平台，請參閱 Postman 說明。

1. 服務帳戶設定

您會取得 serviceAccountKey 和 api_key

  1. 如需詳細步驟，請參閱如何使用服務帳戶存取 API
  2. 在 Google Cloud 專案中，依序點選「憑證」>「建立憑證」>「服務帳戶」
  3. 填寫表單，然後按一下「建立並繼續」
  4. 選取「擁有者」角色，然後按一下「繼續」。
  5. 然後按一下 [完成]。
  6. 如要下載 JSON 金鑰，請按照下列步驟操作：
    1. 按一下剛建立的服務帳戶電子郵件地址 (類似於 {YOUR_SERVICE_ACCOUNT}@{RANDOM_DOMAIN}.gserviceaccount.com)
    2. 按一下「金鑰」分頁標籤
    3. 依序按一下「新增金鑰」 >「建立金鑰」。
    4. 選取「JSON」，然後按一下「建立」下載 JSON

警告：您只能下載金鑰一次，如果遺失金鑰，就必須建立新金鑰並刪除這個金鑰

  1. 開啟 Merchant Center
  2. 依序點選「設定」>「存取和服務」>「使用者與存取權」
  3. 按一下「新增使用者」，然後使用服務帳戶 ID 做為新使用者的電子郵件地址。

2. 設定 Postman

  1. 下載 Postman 環境範本 JSON
  2. 下載 MAPI Postman 集合 JSON
  3. 登入 Postman 或建立新帳戶
  4. 匯入 Postman 環境範本
    1. 將完整 JSON 複製到「Environment」 >「MyAccount」 >「serviceAccountKey」
    2. 將 JSON 中的 private_key 複製到集合的「Environment」>「MyAccount」>「api_key」
  5. 匯入 MAPI Postman 集合 JSON
  6. 選取右上角的環境

3. 開發人員註冊

註冊為開發人員，將 Merchant Center 帳戶連結至 Google Cloud 專案。API 開發人員角色的使用者會收到 API 通訊內容，包括服務公告、開發人員問卷調查和商機。

  1. 依序開啟「Postman」 >「Collections」 >「Merchant API Official」
  2. 依序開啟「accounts_v1」 >「accounts」 >「accounts.developerRegistration」 >「registerGcp」
  3. 將路徑中的 {account} 預留位置替換為你的 MC ID
  4. 將郵件內文中的 {email} 預留位置替換為您的電子郵件地址
  5. 按一下「傳送」即可完成註冊
  6. 如果一切順利，您會收到類似以下的確認 JSON 回應： json { "name": "accounts/{YOUR_MC_ID}/developerRegistration", "gcpIds": [ "{YOUR_GCP_ID}" ] }

4. 在 Postman 上測試 Merchant API

  1. 依序開啟「Postman」 >「Collections」 >「Merchant API Official」 > 「accounts_v1」 >「accounts」 >「list」
  2. 點選 [傳送]
  3. 如果一切順利，您會收到類似以下的確認 JSON 回應： json { "accounts": [ { "name": "accounts/{YOUR_MC_ID}", "accountId": "{YOUR_MC_ID}", "accountName": "{YOUR_MERCHANT_NAME}", "adultContent": false, "timeZone": { "id": "{YOUR_TIMEZONE}" }, "languageCode": "en-US" } ] }