分享方式:


使用支付服務 API 管理支付

本文說明如何透過支付服務 API 而非合作夥伴中心 UI 存取支付數據。 這些 API 提供程式設計方式,以在合作夥伴中心提供匯出數據功能的功能

重要

自 2023 年 6 月 30 日起,Azure Active Directory (Azure AD) Graph 已淘汰。 接下來,我們不會對 Azure AD Graph 進行進一步的投資。 Azure AD Graph API 除了安全性相關修正之外,沒有 SLA 或維護承諾。 我們只會對 Microsoft Graph 投資發展新的功能。

我們會以累加步驟淘汰 Azure AD Graph,讓您有足夠的時間將應用程式移轉至 Microsoft Graph API。 在稍後宣佈的日期,我們將封鎖使用 Azure AD Graph 建立任何新的應用程式。

若要深入瞭解,請參閱 重要事項:Azure AD Graph 淘汰和 Powershell 模組淘汰

可用的 API

請參閱合作夥伴支付的所有可用 API

必要條件

使用 Microsoft 身分識別平台來註冊應用程式

Microsoft 身分識別平台 可協助您建置使用者和客戶可以使用其Microsoft身分識別或社交帳戶登入的應用程式,並提供授權存取您自己的 API 或Microsoft API,例如 Microsoft Graph。

  1. 使用公司或學校帳戶或個人Microsoft帳戶登入 Azure 入口網站

    如果您的帳戶可讓您存取多個租使用者,請選取右上角的帳戶,並將入口網站會話設定為正確的Microsoft Entra 租使用者。

  2. 在左側瀏覽窗格中,選取 [Microsoft Entra 服務],然後選取 [應用程式註冊],然後選取 [新增註冊]。 [註冊應用程式] 頁面隨即顯示。

  3. 輸入應用程式的註冊資訊:

    • 名稱:輸入將向用戶顯示有意義的應用程式名稱。
    • 支援的帳戶類型:選取您的應用程式將支援的帳戶。
    支援的帳戶類型 說明
    只有此組織目錄中的帳戶 如果您要建置企業營運 (LOB) 應用程式,請選取此選項。 如果您未在目錄中註冊應用程式,則無法使用此選項。 此選項會對應至僅限 Entra 的單一租使用者Microsoft。 除非您在目錄外部註冊應用程式,否則此選項為預設值。 在應用程式在目錄外部註冊的情況下,預設值為 entra 多租用戶和個人Microsoft帳戶Microsoft。
    任何組織目錄中的帳戶 如果您想要以所有商務和教育客戶為目標,請選取此選項。 此選項會對應至僅限 Entra 的多租使用者Microsoft。 如果您將應用程式註冊為Microsoft僅限 Entra 單一租使用者,您可以更新為Microsoft Entra 多租使用者,並透過 [驗證] 刀鋒視窗回到單一租使用者。
    任何組織目錄中的帳戶及個人的 Microsoft 帳戶 選取此選項以鎖定最廣泛的一組客戶。 此選項會對應至 Microsoft Entra 多租用戶和個人Microsoft帳戶。 如果您將應用程式註冊為 Microsoft Entra 多租用戶和個人Microsoft帳戶,則無法在 UI 中變更此選取專案。 相反地,您必須使用應用程式指令清單編輯器來變更支援的帳戶類型。
    • (選擇性) 重新導向 URI:選取您要建置的應用程式類型、Web 或公用用戶端(行動裝置和桌面版),然後輸入應用程式的重新導向 URI(或回復 URL)。 (重新導向 URL 是在使用者驗證之後傳送驗證回應的位置。

      針對 Web 應用程式,提供您應用程式的基底 URL。 例如, http://localhost:31544 可能是本機計算機上執行的 Web 應用程式的 URL。 使用者會使用此 URL 來登入 Web 用戶端應用程式。 針對公用用戶端應用程式,請提供Microsoft Entra ID 用來傳回令牌回應的 URI。 輸入應用程式特定的值,例如 myapp://auth

  4. 選取註冊。 Microsoft Entra ID 會將唯一的應用程式(用戶端)標識碼指派給您的應用程式,並載入應用程式的概觀頁面。

  5. 如果您想要將功能新增至應用程式,您可以選取其他組態選項,包括商標、憑證和秘密、API 許可權等等。

平臺特定屬性

下表顯示您需要為不同類型的應用程式設定和複製的屬性。 指派表示您應該使用 Microsoft Entra ID 所指派的值。

應用程式類型 平台 應用程式 (用戶端) 識別碼 用戶端祕密 重新導向 URI/URL 隱含流程
原生/行動裝置 原始 已指派 No 已指派 No
Web App Web 已指派 Yes Yes 選擇性 OpenID Connect 中間件預設會使用混合式流程(是)
單頁應用程式 (SPA) Web 已指派 Yes Yes 是,SPA 使用 OpenID Connect 隱含流程
服務/精靈 Web 已指派 Yes .是 No

建立服務主體

若要存取訂用帳戶中的資源,您必須將角色指派給應用程式。 如需決定哪個角色為應用程式提供正確許可權的說明,請參閱 Azure 內建角色

注意

您可以在訂用帳戶、資源群組或資源層級設定範圍。 權限會繼承至較低層級的範圍。 例如,為資源群組的「讀取者」角色新增應用程式,代表該角色可以讀取資源群組及其所包含的任何資源。

  1. 在 Azure 入口網站 中,選取要指派應用程式的範圍層級。 例如,若要在訂用帳戶範圍指派角色,請搜尋並選取 [訂用帳戶],或選取 首頁上的 [訂用帳戶 ]。

    顯示 [訂用帳戶] 畫面搜尋的螢幕快照。

  2. 選取要指派應用程式的訂用帳戶。

    顯示 [訂用帳戶] 畫面的螢幕快照,其中 [內部測試] 旗標設定為 true。

    注意

    如果您沒有看到您要尋找的訂用帳戶,請選取全域訂用帳戶篩選條件,並確定已針對入口網站選取您想要的訂用帳戶。

  3. 選取 [訪問控制][IAM],然後選取 [ 新增角色指派]。

  4. 選取您想要指派給應用程式的角色。 例如,若要允許應用程式執行重新啟動、啟動和停止執行個體等動作,請選取 [參與者] 角色。 深入瞭解 可用的角色

    根據預設,Microsoft Entra 應用程式不會顯示在可用的選項中。 若要尋找您的應用程式,請搜尋名稱,並從結果中選取它。 在下列螢幕快照中, example-app 是您註冊Microsoft Entra 應用程式。

  5. 選取 [儲存]。 然後,您可以在具有該範圍角色的用戶清單中看到您的應用程式。

    您可以開始使用服務主體來執行文稿或應用程式。 若要管理服務主體的許可權,請參閱使用者同意狀態、檢閱許可權、查看登入資訊等等),在 Azure 入口網站檢視您的企業應用程式。

設定 API 許可權

本節提供如何設定必要 API 許可權的指示。 如需設定合作夥伴中心 API 許可權的詳細資訊,請參閱 合作夥伴 API 驗證

授與圖形 API 的許可權

  1. 開啟 [Azure 入口網站中的應用程式註冊]

  2. 選取應用程式,或如果您還沒有應用程式,請 建立應用程式

  3. 在應用程式的 [概觀] 頁面上,選取 [管理] 底下的 [API 許可權],然後選取 [新增許可權]。

  4. 從可用的 API 清單中選取 [Microsoft Graph]

  5. 選取 [委派的許可權 ],然後新增必要的許可權。 如需詳細資訊,請參閱 設定應用程式存取

    顯示已選取 [Microsoft Graph] Azure 入口網站 中 [要求許可權] 畫面的螢幕快照。

    同意透過 Microsoft Entra 應用程式存取合作夥伴中心 API

  6. 針對您的應用程式,選取 [API 許可權],然後從 [要求 API 許可權] 畫面選取 [新增許可權],然後選取 [我的組織所使用的 API]。

  7. 搜尋Microsoft合作夥伴 (Microsoft 開發人員中心) API (4990cffe-04e8-4e8b-808a-1175604b879f)

    顯示 [API 許可權] 畫面的螢幕快照,其中已選取 [Microsoft合作夥伴]。

  8. 將委派的許可權設定為 合作夥伴中心

    此螢幕快照顯示 [要求 API 許可權] 畫面中針對合作夥伴中心選取的 [委派許可權]。

  9. 與系統管理員對 API 的同意

    顯示 API 許可權畫面上系統管理員同意切換的螢幕快照。

    確認管理員同意已在 [管理員同意狀態] 畫面中啟用。

    顯示管理員同意狀態畫面的螢幕快照

  10. 在 [驗證]段中,確定 [允許公用用戶端流程] 選項設定為 []。

在 Visual Studio 中執行範例程式代碼

示範 API 如何用於付款和交易歷程記錄的範例程式代碼,請參閱 Partner-Center-Payout-API GitHub 存放庫。

範例程式代碼注意事項

  • 如驗證:如何在 Azure 入口網站 中建立服務主體的兩個選項一節中所述,設定用戶端秘密和憑證。
  • 目前不支援多重要素驗證的帳戶(MFA),而且會造成錯誤。
  • 支付 API 僅支援使用者/密碼型認證。