邮递员 API

Postman API端点使您能够将 Postman 集成到您的开发工具链中。

您可以直接通过 API 添加新集合、更新现有集合、更新环境以及添加和运行监视器。这使您能够以编程方式访问存储在 Postman 帐户中的数据。

您可以通过分叉其集合来开始使用 API。有关更多详细信息，请参阅Postman API 文档。

您将需要一个API 密钥来访问 Postman API。

Postman API 是速率受限的。

生成 Postman API 密钥

您需要有效的 API 密钥才能向 Postman API 发送请求。要生成 API 密钥：

  1. 导航到您的Postman API Keys 页面。在右上角选择您的头像 >帐户设置。然后选择Postman API 密钥。

  2. 如果您还没有任何密钥，系统将提示您创建一个。选择生成 API 密钥。

    生成 API 密钥

  3. 输入密钥的名称并选择Generate API Key。

  4. 复制您的密钥，然后关闭。

复制您的 API 密钥

生成 API 密钥后，您可以在工作区中管理它们。选择三个点图标密钥旁边的以重新生成或删除它。

查看您的 API 密钥

使用API 密钥设置来指定密钥的到期期限。

API 密钥设置

验证

您需要通过在您发出X-Api-Key的每个请求的标头中发送您的 API 密钥来验证您对 Postman API 的请求。

您还可以将密钥作为apikeyURL 查询参数发送。如果您同时使用请求标头和查询参数发送密钥，则作为标头一部分发送的 API 密钥具有更高的优先级。

您的 API 密钥提供对您有权访问的任何 Postman 数据的访问权限。

您可以将 API 密钥存储在变量中。如果您命名它postman_api_key，Postman API 集合将自动使用它

速率限制

API 访问速率限制在单位时间内按每个密钥应用。

使用密钥访问 API 被限制为每分钟 300 个请求。每个 API 响应都包含以下一组标头，用于识别您的消费状态。

标题 描述
X-RateLimit-Limit 允许消费者每分钟发出的最大请求数。
X-RateLimit-Remaining 当前速率限制窗口中剩余的请求数。
X-RateLimit-Reset 当前速率限制窗口重置的时间（以 UTC 纪元秒为单位）。

使用您的 Postman 帐户进行免费 API 调用

您的 Postman 帐户每月为您提供有限数量的免费 Postman API 调用。您可以通过Postman API本身或帐户使用页面检查您的使用限制。

下一步

您可以将 Postman API 与 Newman 结合使用，以将 Postman 与您的 CI/CD 工作流集成。