Sdílet prostřednictvím


Správa výplat pomocí rozhraní API služby Výplaty

Tento článek vysvětluje, jak můžete přistupovat k datům plateb prostřednictvím rozhraní API služby payout místo uživatelského rozhraní Partnerského centra. Tato rozhraní API poskytují programový způsob, jak poskytovat funkce Export dat v Partnerském centru.

Důležité

Azure Active Directory (Azure AD) Graph je od 30. června 2023 zastaralý. V budoucnu do Azure AD Graphu neplánujeme žádné další investice. Rozhraní API Azure AD Graph nemají žádné závazky, co se týče SLA nebo údržby, kromě oprav souvisejících se zabezpečením. Investice do nových funkcí a funkcí budou provedeny pouze v Microsoft Graphu.

Azure AD Graph vyřadíme v přírůstkových krocích, abyste měli dostatek času na migraci aplikací do rozhraní Microsoft Graph API. Později, kdy budeme oznamovat, zablokujeme vytváření nových aplikací pomocí Azure AD Graphu.

Další informace najdete v tématu Důležité: Ukončení podpory Azure AD Grafu a modulu PowerShellu.

Dostupná rozhraní API

Zobrazit všechna dostupná rozhraní API v programu Partner Payouts.

Požadavky

Registrace aplikace na platformě Microsoft Identity Platform

Microsoft Identity Platform pomáhá vytvářet aplikace, které vaši uživatelé a zákazníci můžou přihlašovat pomocí svých identit Microsoftu nebo sociálních účtů, a poskytovat autorizovaný přístup k vlastním rozhraním API nebo rozhraním Microsoft API, jako je Microsoft Graph.

  1. Přihlaste se k webu Azure Portal pomocí pracovního nebo školního účtu nebo osobního účtu Microsoft.

    Pokud váš účet poskytuje přístup k více než jednomu klientovi, vyberte svůj účet v pravém horním rohu a nastavte relaci portálu tak, aby odpovídala správnému tenantovi Microsoft Entra.

  2. V levém navigačním podokně vyberte službu Microsoft Entra a pak Registrace aplikací a pak novou registraci. Zobrazí se stránka Registrace aplikace .

  3. Zadejte registrační informace vaší aplikace:

    • Název: Zadejte smysluplný název aplikace, který se zobrazí uživatelům aplikace.
    • Podporované typy účtů: Vyberte účty, které bude vaše aplikace podporovat.
    Podporované typy účtů Popis
    Pouze účty v tomto organizačním adresáři Tuto možnost vyberte, pokud vytváříte oborově specializovanou aplikaci. Tato možnost není dostupná, pokud aplikaci neregistrujete v adresáři. Tato možnost se mapuje na microsoft Entra-only single-tenant. Tato možnost je výchozí, pokud aplikaci neregistrujete mimo adresář. V případech, kdy je aplikace zaregistrována mimo adresář, je výchozím nastavením účty Microsoft Entra pro více nájemců a osobní účty Microsoft.
    Účty v libovolném organizačním adresáři Tuto možnost vyberte, pokud chcete cílit na všechny zákazníky z řad firem a vzdělávacích institucí. Tato možnost se mapuje výhradně na multitenant Microsoft Entra. Pokud jste aplikaci zaregistrovali jako jednotenantní v Microsoft Entra, můžete ji aktualizovat na vícetenantní a poté opět jako jednotenantní, a to prostřednictvím panelu Ověřování.
    Účty v libovolném organizačním adresáři a osobních účtech Microsoft Tuto možnost vyberte, chcete-li zaměřit nejširší sadu odběratelů. Tato možnost se vztahuje na víceklientské účty Microsoft Entra a osobní účty Microsoft. Pokud jste aplikaci zaregistrovali jako víceklientskou aplikaci Microsoft Entra a osobní Microsoft účty, nemůžete tento výběr změnit v uživatelském rozhraní. Místo toho je nutné pomocí editoru manifestu aplikace změnit podporované typy účtů.
    • (volitelné) Identifikátor URI pro přesměrování: Vyberte typ aplikace, kterou vytváříte, webového nebo veřejného klienta (mobilní &desktop) a zadejte identifikátor URI přesměrování (nebo adresu URL odpovědi) pro vaši aplikaci. (Adresa URL přesměrování je místo, kde se po ověření uživatele odešle odpověď na ověření.)

      V případě webových aplikací zadejte základní adresu URL vaší aplikace. Například http://localhost:31544 může být adresa URL pro webovou aplikaci spuštěnou na místním počítači. Uživatelé by se pomocí této adresy URL přihlašovali k webové klientské aplikaci. U veřejných klientských aplikací zadejte identifikátor URI používaný Microsoft Entra ID k vrácení tokenových odpovědí. Zadejte konkrétní hodnotu pro vaši aplikaci, například myapp://auth.

  4. Vyberte Zaregistrovat. Microsoft Entra ID přiřadí vaší aplikaci jedinečné ID aplikace (klienta) a stránka s přehledem aplikace se načte.

  5. Pokud chcete do aplikace přidat možnosti, můžete vybrat další možnosti konfigurace, včetně brandingu, certifikátů a tajných kódů, oprávnění rozhraní API a dalších.

Vytvoření principála služby

Pokud chcete získat přístup k prostředkům ve vašem předplatném, musíte aplikaci přiřadit roli. Nápovědu k rozhodování o tom, která role nabízí správná oprávnění pro aplikaci, najdete v tématu Předdefinované role Azure.

Poznámka:

Obor můžete nastavit na úrovni předplatného, skupiny prostředků nebo prostředku. Oprávnění se dědí do nižších úrovní oboru. Například přidání aplikace do role Čtenář pro skupinu prostředků znamená, že může číst skupinu prostředků a všechny prostředky, které obsahuje.

  1. Na webu Azure Portal vyberte úroveň oboru, ke které chcete aplikaci přiřadit. Pokud chcete například přiřadit roli v oboru předplatného, vyhledejte a vyberte Předplatná nebo na domovské stránce vyberte Předplatná .

    Snímek obrazovky zobrazující funkci vyhledávání na obrazovce Předplatná

  2. Vyberte předplatné, ke kterému chcete aplikaci přiřadit.

    Snímek obrazovky zobrazující obrazovku s předplatným, kde je příznak interního testování nastavený jako pravdivý.

    Poznámka:

    Pokud nevidíte předplatné, které hledáte, vyberte globální filtr předplatných a ujistěte se, že je pro portál vybrané požadované předplatné.

  3. Vyberte Řízení přístupu (IAM) a pak vyberte Přidat přiřazení role.

  4. Vyberte roli, kterou chcete přiřadit k aplikaci. Pokud například chcete aplikaci povolit provádění akcí, jako je restartování, spuštění a zastavení instancí, vyberte roli Přispěvatel. Přečtěte si další informace o dostupných rolích.

    Ve výchozím nastavení se aplikace Microsoft Entra nezobrazují v dostupných možnostech. Pokud chcete najít aplikaci, vyhledejte název a vyberte ji z výsledků. Na níže uvedeném snímku obrazovky je aplikace Microsoft Entra, example-app, kterou jste zaregistrovali.

  5. Zvolte Uložit. Aplikaci pak můžete zobrazit v seznamu uživatelů s rolí pro daný obor.

    Můžete začít používat hlavní službu ke spouštění skriptů nebo aplikací. Pokud chcete spravovat oprávnění hlavní služby, zobrazit stav souhlasu uživatele, zkontrolovat oprávnění, podívat se na informace o přihlášení a další položky, prohlédněte si svoje podnikové aplikace v Azure portálu.

Nastavení oprávnění rozhraní API

Tato část obsahuje pokyny k nastavení požadovaných oprávnění rozhraní API. Další informace o nastavení oprávnění rozhraní API Partnerského centra najdete v tématu Ověřování rozhraní PARTNER API.

Udělení oprávnění rozhraní Graph API

  1. Otevřete Registrace aplikací na webu Azure Portal.

  2. Vyberte aplikaci nebo vytvořte aplikaci , pokud ji ještě nemáte.

  3. Na stránce Přehled aplikace vyberte v části Spravovat oprávnění rozhraní API a pak přidejte oprávnění.

  4. V seznamu dostupných rozhraní API vyberte Microsoft Graph .

  5. Vyberte Delegovaná oprávnění a přidejte požadovaná oprávnění. Další informace najdete v tématu Konfigurace přístupu k aplikacím.

    Snímek obrazovky s oprávněními žádosti na webu Azure Portal s vybranou možností Microsoft Graph

    Vyjádření souhlasu s přístupem k rozhraní API Partnerského centra prostřednictvím aplikace Microsoft Entra

  6. Pro vaši aplikaci vyberte oprávnění rozhraní API a pak na obrazovce Požádat o oprávnění rozhraní API vyberte Přidat oprávnění a pak rozhraní API, která používá moje organizace.

  7. Vyhledejte rozhraní API Microsoft Partner (Microsoft Dev Center) (4990cffe-04e8-4e8b-808a-1175604b879f).

    Snímek obrazovky s oprávněními rozhraní API s vybraným partnerem Microsoftu

  8. Nastavte delegovaná oprávnění do Partnerského centra.

    Snímek obrazovky znázorňující delegovaná oprávnění vybraná pro Partnerské centrum na obrazovce Oprávnění rozhraní API žádosti

  9. Udělení souhlasu správce pro rozhraní API

    Snímek obrazovky znázorňující přepínač pro souhlas správce na obrazovce oprávnění rozhraní API

    Ověřte, že je na obrazovce stavu souhlasu správce povolen souhlas správce.

    Snímek obrazovky se stavem souhlasu správce

  10. V části Ověřování se ujistěte, že je možnost Povolit toky veřejného klienta nastavená na Ano.

Spusťte ukázkový kód ve Visual Studiu

Ukázkový kód, který znázorňuje, jak se dá API použít pro platby a historii transakcí, najdete v úložišti na GitHubu v Partner-Center-Payout-APIs.

Ukázkové poznámky ke kódu

  • Konfigurace tajemství klienta a certifikátů, jak je diskutováno v části Ověřování: Dvě možnosti v návodu "Jak vytvořit entitu služby na portálu Azure" se nevyžaduje.
  • Účty s vícefaktorovým ověřováním (MFA) se v současné době nepodporují a způsobí chybu.
  • Rozhraní API pro výplaty podporuje pouze přihlašovací údaje založené na uživatelích a heslech.