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 复制到环境 > MyAccount > serviceAccountKey
    2. 将 JSON 中的 private_key 复制到集合的环境 > 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" } ] }