Postman API 文档
Postman API 端点让你可以将 Postman 集成到你的开发工具链中。
你可以使用 API 添加新集合、更新集合和环境、添加和运行监视器等。这允许你以编程方式访问存储在你的 Postman 帐户中的数据。你还可以 将 Postman API 与 Newman 结合使用 ,以将 Postman 与你的 CI/CD 工作流集成。
入门
你可以通过在 Postman 公共工作空间中 Forking 集合 来开始使用 API 。有关详细信息,请参阅 Postman API 文档 。
你将需要一个 API 密钥 来访问 Postman API。
Postman API 是有 速率限制的 。
关于 v9 和 v10 API
在 Postman v10 中更改了在 Postman 中创建的 API 的格式。Postman API 现在支持使用 v10 中创建的 API 的端点。
用于使用在 v9 中创建的 API 的端点已弃用。你可以继续使用这些端点,但将来它们将不再可用。你应该尽快开始使用 新的 v10 API 端点。
要查看 v9 和 v10 端点,请转到 Postman API 的公共工作空间 并选择API > v9或API > v10文件夹。
弃用的 v9 API 端点
以下 Postman API 端点已弃用。你可以继续使用这些端点,但将来它们将不再可用。你应该尽快开始使用 新的 v10 API 端点。
/apis
/apis/{apiId}
/apis/{apiId}/versions
/apis/{apiId}/versions/{apiVersionId}
/apis/{apiId}/versions/{apiVersionId}/unclassified
/apis/{apiId}/versions/{apiVersionId}/contracttest
/apis/{apiId}/versions/{apiVersionId}/documentation
/apis/{apiId}/versions/{apiVersionId}/environment
/apis/{apiId}/versions/{apiVersionId}/integrationtest
/apis/{apiId}/versions/{apiVersionId}/mock
/apis/{apiId}/versions/{apiVersionId}/monitor
/apis/{apiId}/versions/{apiVersionId}/relations
/apis/{apiId}/versions/{apiVersionId}/schemas
/apis/{apiId}/versions/{apiVersionId}/schemas/{schemaId}
/apis/{apiId}/versions/{apiVersionId}/schemas/{schemaId}/collections
/apis/{apiId}/versions/{apiVersionId}/test
/apis/{apiId}/versions/{apiVersionId}/testsuite
/apis/{apiId}/versions/{apiVersionId}/{relationType}/{entityId}/syncWithSchema
新的 v10 API 端点
要使用新的 Postman API 端点,你必须 将 API 更新为 v10 格式 。你还必须传递Accept
值为 的 headerapplication/vnd.api.v10+json
。(一些新端点看起来与已弃用的端点相同,但它们在你发送此Accept
header 时使用新的 v10 行为。)
/apis
/apis/{apiId}
/apis/{apiId}/schemas
/apis/{apiId}/collections
/apis/{apiId}/versions
/apis/{apiId}/tasks/{taskId}
/apis/{apiId}/schemas/{schemaId}
/apis/{apiId}/versions/{versionId}
/apis/{apiId}/schemas/{schemaId}/files
/apis/{apiId}/collections/{collectionId}
/apis/{apiId}/schemas/{schemaId}/files/{file-path}
/apis/{apiId}/collections/{collectionId}/sync-with-schema-tasks