通过

云合作伙伴门户 API 参考

  • 项目

注意

云合作伙伴门户 API 已与合作伙伴中心集成，并将继续在其中工作。 本次转换引入的变更很少。 请查看本文档中列出的 CPP API 更改，以确保在转换到合作伙伴中心后，代码能继续工作。 CPP API 应仅用于在转换到合作伙伴中心之前已经集成的现有产品；新产品应使用合作伙伴中心提交 API。

云合作伙伴门户 REST API允许以编程方式检索和操作工作负载、产品/服务和发布者配置文件。 API 使用 Azure 基于角色的访问控制 (Azure RBAC)，在处理时强制实施正确的权限。

本参考提供云合作伙伴门户 REST API 的技术详细信息。 本文档中的有效负载示例仅供参考，随着新功能的添加可能会发生变化。

先决条件和注意事项

在使用 API 之前，应该查看：

  • 先决条件文章介绍如何将服务主体添加到帐户，并获取用于身份验证的 Microsoft Entra 访问令牌。
  • 有两种并发控制策略可用于调用这些 API。
  • 其他 API 注意事项，例如版本控制和错误处理。

迁移到合作伙伴中心后，CPP API 发生的更改

API 更改描述 影响
POST 发布、上线、取消 对于已迁移的产品/服务，响应标头具有不同的格式，但继续以相同的方式工作，表示要检索操作状态的相对路径。 为产品/服务发送任何相应的 POST 请求时，Location 标头具有两种格式之一，具体取决于产品/服务的迁移状态：
  • 非移民产品/服务
    /api/operations/{PublisherId}${offerId}$2$preview?api-version=2017-10-31
  • 已迁移的产品/服务
    /api/publishers/{PublisherId}/offers/{offereId}/operations/408a4835-0000-1000-0000-000000000000?api-version=2017-10-31
GET 操作 对于之前支持在响应中使用“notification-email”字段的产品/服务类型，此字段将被弃用，且将不对已迁移的产品/服务返回此字段。 对于已迁移的产品/服务，我们将不再向请求中指定的一列电子邮件地址发送通知。 相反，API 服务与合作伙伴中心中的通知电子邮件流程保持一致，以发送电子邮件。 具体而言，通知将发送至合作伙伴中心内在你的帐户设置的卖家联系人信息部分中设定的电子邮件地址，告知你操作进度。

查看合作伙伴中心帐户设置的卖家联系信息部分中设置的电子邮件地址，以确保为通知提供正确的电子邮件。

常见任务

本参考详细介绍了用于执行以下常见任务的 API。

产品

操作

发布应用

其他任务

疑难解答

API 版本和更新

更新 什么发生了变化？
12-2022 CPP 公共 API（版本 2017-10-31）现已更新，用于捕获 Marketo 连接器的 clientId 和 clientSecret，同时配置潜在客户。 在潜在顾客配置期间，不需要提供未来 serverId 字段。 对 API 的此更新不涉及任何版本更新或中断性变更。