使用付款服务 API 管理付款

本文介绍如何通过付款服务 API 而不是合作伙伴中心 UI 访问付款数据。 这些 API 提供了一种编程方式,用于在合作伙伴中心提供 导出数据 功能的功能。

可用 API

请参阅 合作伙伴付款中的所有可用 API。

先决条件

将应用程序注册到 Microsoft 标识平台

Microsoft 标识平台可帮助你构建用户和客户可以使用其 Microsoft 标识或社交帐户登录的应用程序,并提供对自己的 API 或 Microsoft API(如 Microsoft Graph)的授权访问权限。

  1. 使用工作或学校帐户或个人 Microsoft 帐户登录到 Azure 门户

    如果帐户允许你访问多个租户,请在右上角选择帐户,并将门户会话设置为正确的Azure AD租户。

  2. 在左侧导航窗格中,选择Azure Active Directory服务,然后应用注册,然后选择“新建注册”。 会显示“注册应用程序”页。

    Screenshot showing the Register an app screen in the Azure portal.

  3. 输入应用程序的注册信息:

    • 名称:输入一个有意义的应用程序名称,该名称将显示给应用的用户。
    • 支持的帐户类型:选择应用程序将支持的帐户。
    支持的帐户类型 说明
    仅此组织目录中的帐户 若要生成业务线 (LOB) 应用程序,请选择此选项。 如果不在目录中注册应用程序,则此选项不可用。 此选项映射到仅限 Azure AD 的单租户。 此选项是默认选项,除非你是在目录外部注册应用。 如果在目录外部注册应用,则默认设置为 Azure AD 多租户和个人 Microsoft 帐户。
    任何组织目录中的帐户 若要面向所有企业和教育客户,请选择此选项。 此选项映射到仅限 Azure AD 的多租户。 如果已将应用注册为仅限 Azure AD 的单租户,则可通过“身份验证”边栏选项卡将其更新为 Azure AD 多租户,以及从多租户更新为单租户。
    任何组织目录中的帐户和个人 Microsoft 帐户 若要面向最广泛的客户,请选择此选项。 此选项映射到 Azure AD 多租户和个人 Microsoft 帐户。 如果将应用注册为Azure AD多租户和个人 Microsoft 帐户,则无法在 UI 中更改此选择。 而只能使用应用程序清单编辑器来更改支持的帐户类型。
    • 可选 () 重定向 URI:选择要构建的应用类型、Web 或公共客户端 (移动 & 桌面) ,然后输入应用程序的重定向 URI (或回复 URL) 。 (重定向 URL 是在用户进行身份验证后发送身份验证响应的位置。)

      对于 Web 应用程序,请提供应用的基 URL。 例如, http://localhost:31544 可以是本地计算机上运行的 Web 应用的 URL。 用户将使用此 URL 登录到 Web 客户端应用程序。 对于公共客户端应用程序,请提供 Azure AD 返回令牌响应时所用的 URI。 输入特定于应用程序的值,例如 myapp://auth

  4. 选择“注册”。 Azure AD向应用程序分配唯一的应用程序 (客户端) ID,并加载应用程序的概述页。

    <alt text>

  5. 如果要向应用程序添加功能,可以选择其他配置选项,包括品牌、证书和机密、API 权限等。

特定于平台的属性

下表显示了需要为不同类型的应用配置和复制的属性。 分配意味着应使用Azure AD分配的值。

应用类型 平台 应用程序(客户端)ID 客户端机密 重定向 URI/URL 隐式流
本机/移动 本机 已分配 已分配
Web 应用 Web 已分配 可选的开放 ID 连接中间件默认使用混合流, (是)
单页应用 (SPA) Web 已分配 是的 SPA 使用 Open ID 连接隐式Flow
服务/守护程序 Web 已分配

创建服务主体

若要访问订阅中的资源,必须将角色分配给应用程序。 有关确定哪个角色为应用程序提供适当权限的帮助,请参阅 Azure 内置角色

注意

可将作用域设置为订阅、资源组或资源级别。 较低级别的作用域会继承权限。 例如,将某个应用程序添加到资源组的“读取者”角色意味着该应用程序可以读取该资源组及其包含的所有资源。

  1. 在Azure 门户中,选择要向其分配应用程序的作用域级别。 例如,若要在订阅范围内分配角色,请搜索并选择“ 订阅”,或在主页上选择“ 订阅 ”。

    Screenshot showing the Subscriptions screen search.

  2. 选择要将应用程序分配到的订阅。

    Screenshot showing the Subscriptions screen with Internal Testing flag set to true.

注意

如果未看到要查找的订阅,请选择全局订阅筛选器,并确保为门户选择所需的订阅。

  1. 依次选择“访问控制(IAM)”、“添加角色分配”

  2. 选择要分配到应用程序的角色。 例如,若要允许应用程序执行诸如“重新启动”、“启动”和“停止”实例之类的操作,请选择“参与者”角色 。 详细了解 可用角色

    默认情况下,可用选项中不显示 Azure AD 应用程序。 若要查找应用程序,请搜索名称并从结果中选择它。 在以下屏幕截图中,example-app是已注册AAD应用。

    Screenshot showing the user interface for adding a role assignment for a test application.

  3. 选择“保存”。 然后,可以在具有该作用域角色的用户列表中查看应用程序。

    可以使用服务主体开始运行脚本或应用。 若要管理服务主体的权限,请参阅用户同意状态、查看权限、查看登录信息等) ,查看Azure 门户中的Enterprise应用程序。

设置 API 权限

本部分提供有关如何设置所需 API 权限的说明。 有关设置合作伙伴中心 API 权限的详细信息,请参阅 合作伙伴 API 身份验证

授予对图形 API的权限

  1. 在Azure 门户中打开应用注册

  2. 选择一个应用程序,或者创建 一个 应用(如果还没有)。

  3. 在应用程序的“概述”页上,在“ 管理”下,选择 “API 权限”,然后 添加权限

  4. 从可用 API 的列表中选择“Microsoft Graph”。

  5. 选择 “委派权限 ”并添加所需的权限。 有关详细信息,请参阅 配置应用访问权限

    Screenshot showing the request permissions screen in the Azure portal with Microsoft Graph selected.

同意通过 AAD 应用访问合作伙伴中心 API

  1. 对于应用程序,选择 API 权限,然后,从“请求 API 权限”屏幕中选择 “添加权限”,然后选择 组织使用的 API

  2. 搜索 Microsoft 合作伙伴 (Microsoft 开发人员中心) API (4990cffe-04e8-4e8b-808a-1175604b879f)

    Screenshot showing the API permissions screen with Microsoft Partner selected.

  3. 将委派的权限设置为 合作伙伴中心

    Screenshot showing the Delegated Permissions selected for Partner Center in the Request API permissions screen.

  4. 授予对 API 的 管理员同意

    Screenshot showing the toggle for Admin Consent on the API permissions screen.

    验证管理员同意是否在“管理员同意状态”屏幕中启用。

    Screenshot showing the Admin consent status screen

  5. “身份验证 ”部分中,确保 “允许公共客户端流 ”选项设置为 “是”。

    Screenshot showing the Authentication screen with Allow public client flows set to Yes.

在 Visual Studio 中运行示例代码

演示如何在 Partner-Center-Payout-API GitHub存储库中找到 API 用于付款和交易历史记录的示例代码。

示例代码说明

  • 身份验证中所述的客户端机密和证书配置:不需要在Azure 门户中创建服务主体的两个选项部分。
  • 目前不支持多重身份验证 (MFA) 帐户,并会导致错误。
  • 付款 API 仅支持基于用户/密码的凭据。

后续步骤