步骤 2:设置 Postman - Amazon Pinpoint

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

步骤 2:设置 Postman

现在,您已经创建了一个能够访问 Amazon Pinpoint API 的用户,接下来可以设置 Postman 了。在本部分,您将在 Postman 中创建一个或多个环境。接下来,您将导入一个集合,其中包含 Amazon Pinpoint API 中的每项操作的请求模板。

在 Postman 中,工作区 是项目和环境的组织容器。在本节中,您将至少创建一个工作区以与 Amazon Pinpoint 配合使用。

创建工作区

在 Postman 中,选择更多操作,选择文件,然后选择新建

  1. 新建窗口中,选择工作区

  2. 输入名称和摘要,并将可见性设置为个人。选择创建工作区

在 Postman 中,环境 是一组存储为键/值对的变量。您可以使用环境来更改通过 Postman 发出的请求的配置,而无需更改 API 请求本身。

在本部分,您将创建至少一个环境以与 Amazon Pinpoint 配合使用。您创建的每个环境都包含一组变量,这些变量特定于您在单个 AWS 区域中的账户。如果您使用本部分中的过程创建多个环境,则可通过从 Postman 的环境菜单中选择不同的环境,在不同区域之间轻松切换。

创建环境
  1. 在 Postman 中,选择更多操作菜单,选择文件,然后选择新建

  2. 新建窗口中,选择环境

  3. 管理环境窗口中,对于环境名称,输入 Amazon Pinpoint - Region Name。将区域名称替换为以下值之一:

    • 美国东部(弗吉尼亚州北部)

    • 美国西部(俄勒冈州)

    • 亚太地区(孟买)

    • 亚太地区(悉尼)

    • 欧洲地区(法兰克福)

    • 欧洲(爱尔兰)

    注意

    您至少只需要为单个环境创建一个环境 AWS 区域,并且该环境 AWS 区域 必须包含一个项目。如果您尚未在前面列出的项目中创建项目 AWS 区域,请参阅亚马逊 Pinp oint 用户指南中的使用电子邮件支持创建亚马逊 Pinpoin t 项目

  4. 创建六个新变量:endpointregionserviceNameaccountIdaccessKeysecretAccessKey。使用下表确定要在每个变量的初始值当前值列中输入哪个值。

    区域 Variable 初始值和当前值
    美国东部(弗吉尼亚州北部) endpoint pinpoint.us-east-1.amazonaws.com
    region us-east-1
    serviceName mobiletargeting
    accountId (您的 AWS 账户 ID)
    accessKey (您的 IAM 访问密钥 ID)
    secretAccessKey (您的 IAM 秘密访问密钥)
    美国西部(俄勒冈州) endpoint pinpoint.us-west-2.amazonaws.com
    region us-west-2
    serviceName mobiletargeting
    accountId (您的 AWS 账户 ID)
    accessKey (您的 IAM 访问密钥 ID)
    secretAccessKey (您的 IAM 秘密访问密钥)
    亚太地区(孟买) endpoint pinpoint.ap-south-1.amazonaws.com
    region ap-south-1
    serviceName mobiletargeting
    accountId (您的 AWS 账户 ID)
    accessKey (您的 IAM 访问密钥 ID)
    secretAccessKey (您的 IAM 秘密访问密钥)
    亚太地区(悉尼) endpoint pinpoint.ap-southeast-2.amazonaws.com
    region ap-southeast-2
    serviceName mobiletargeting
    accountId (您的 AWS 账户 ID)
    accessKey (您的 IAM 访问密钥 ID)
    secretAccessKey (您的 IAM 秘密访问密钥)
    欧洲地区(法兰克福) endpoint pinpoint.eu-central-1.amazonaws.com
    region eu-central-1
    serviceName mobiletargeting
    accountId (您的 AWS 账户 ID)
    accessKey (您的 IAM 访问密钥 ID)
    secretAccessKey (您的 IAM 秘密访问密钥)
    欧洲地区(爱尔兰) endpoint pinpoint.eu-west-1.amazonaws.com
    region eu-west-1
    serviceName mobiletargeting
    accountId (您的 AWS 账户 ID)
    accessKey (您的 IAM 访问密钥 ID)
    secretAccessKey (您的 IAM 秘密访问密钥)

    创建这些变量后,管理环境窗口类似于下图所示的示例。

    Postman 中的“管理环境”窗口。该屏幕截图显示一个名为“美国东部(弗吉尼亚州北部)”的环境。该环境包含以下变量: 一个名为“endpoint”且初始值为“pinpoint.us-east-1.amazonaws.com”的变量。 一个名为“region”且初始值为“us-east-1”的变量。 一个名为“serviceName”且初始值为“mobiletargeting”的变量。 一个名为 “accountID” 的变量,初始值为 123456789012(虚构的账户 ID)。 AWS 一个名为“accessKey”且初始值为 AKIAIOSFODNN7EXAMPLE(虚构的访问密钥 ID)的变量。 一个名为 “secretAccessKey” 的变量和 wjalrxutnfemi/k7mdeng/ CYEXAMPLEKEY(虚构的私有访问密钥bPxRfi)的初始值。

    完成后,选择保存

    重要

    上图所示的访问密钥是虚构的。不要与他人共享您的 IAM 访问密钥。

    Postman 包含允许您共享和导出环境的功能。如果您使用这些功能,切勿与不应访问这些凭证的任何人分享您的访问密钥 ID 和秘密访问密钥。

    有关更多信息,请参阅《IAM 用户指南》中的 IAM 最佳实践

  5. (可选)对于您要创建的每个额外环境,请重复步骤 1-4。

    提示

    在 Postman 中,您可以根据需要创建任意多个环境。您可以通过以下方式使用环境:

    • 为必须进行 Amazon Pinpoint API 测试的每个区域创建一个单独的环境。

    • 创建与不同的 AWS 账户账户关联的环境。

    • 创建使用与其他用户关联的凭证的环境。

  6. 创建完环境后,请继续完成下一部分。

在 Postman 中,集合 是一组 API 请求。集合中的请求通常由一个共同的目的联系在一起。在本部分,您将创建一个新集合,其中包含 Amazon Pinpoint API 中的每项操作的请求模板。

创建 Amazon Pinpoint 集合
  1. 在 Postman 中,选择更多操作菜单,选择文件,然后选择导入

  2. 在 “导入” 窗口中,选择 “从链接导入”,然后输入以下 URL:https://raw.githubusercontent.com/awsdocs/ amazon-pinpoint-developer-guide /master/Amazon %20pinpoint.post man_Collection.json。

    选择导入。Postman 将导入 Amazon Pinpoint 集合,其中包含 120 个示例请求。

导入 Amazon Pinpoint 集合后,建议您执行快速测试,以确认所有组件是否都配置正确。可以通过提交 GetApps 请求来测试您的配置。此请求将返回当前 AWS 区域内您的 Amazon Pinpoint 账户中存在的所有项目的列表。此请求不需要任何额外配置,因此这是一种测试配置的好办法。

测试 Amazon Pinpoint 集合的配置
  1. 在左侧导航窗格中,选择集合,展开 Amazon Pinpoint 集合,然后展开应用程序文件夹。

  2. 在请求列表中,选择GetApps

  3. 使用环境选择器选择您在创建 Postman 环境中创建的环境

  4. 选择发送。如果请求成功发送,则响应窗格显示 200 OK 状态。您将看到一个类似于下图中的示例的响应。

    该响应显示了 “名称”、“ID”、“Arn” 和 “标签” 的示例值。
    注意

    如果你没有在中创建任何项目, AWS 区域 那么 Amazon Pinpoint 就会返回。{ "Item": [] }

    此响应显示您在步骤 3 中选择的区域内的账户中存在的所有 Amazon Pinpoint 项目的列表。

故障排除

当您提交请求时,可能会看到错误。请查看以下列表,了解可能会遇到的几个常见错误,以及可以采取的解决问题的步骤。

错误消息 问题 解决方案

无法得到任何响应

连接到 https://%7B%7Bendpoint%7D%7D/v1/apps 时出错。

{{endpoint}} 变量当前没有值,在您选择环境时才设置值。

使用环境选择器选择一个环境。

请求中包含的安全令牌无效。

Postman 未能找到您的访问密钥 ID 或秘密访问密钥的当前值。

选择环境选择器旁边的齿轮图标,然后选择当前环境。确认 accessKeysecretAccessKey 值显示在初始值当前值列中,并且您正确输入了凭证。

“消息”:“用户:arn: aws: iam:: 123456789012: user/ 无权执行:mobileTargeting:在资源上:arn: aws: mobileTargeting: us-west-2:123456789012PinpointPostmanUser: *” GetApps

与您的用户关联的 IAM 策略不包含相应权限。

验证您的用户是否具有创建 IAM 策略中描述的权限,以及您在创建 Postman 工作区中创建环境时是否提供了正确的证书。

下一步发送其他请求