Verwalten von Auszahlungen mithilfe der Auszahlungsdienst-API

Artikel
03/11/2024

In diesem Artikel wird erläutert, wie Sie über die Auszahlungsdienst-APIs anstelle der Partner Center-Benutzeroberfläche auf Auszahlungsdaten zugreifen können. Diese APIs bieten eine programmgesteuerte Möglichkeit, die Funktion des Features "Daten exportieren" im Partner Center bereitzustellen.

Wichtig

Azure Active Directory (Azure AD) Graph ist ab dem 30. Juni 2023 veraltet. In Zukunft investieren wir nicht mehr in Azure AD Graph. Azure AD Graph-APIs haben keine SLA- oder Standard Zusicherung über sicherheitsbezogene Fixes hinaus. Investitionen in neue Features und Funktionalitäten werden nur für Microsoft Graph vorgenommen.

Azure AD Graph wird inkrementellen Schritten eingestellt, sodass Sie genügend Zeit haben, um Ihre Anwendungen zu Microsoft Graph-APIs zu migrieren. Zu einem späteren Zeitpunkt, an dem wir ihnen mitteilen werden, werden wir die Erstellung neuer Anwendungen mit Azure AD Graph blockieren.

Weitere Informationen finden Sie unter "Wichtig": Veraltetes Azure AD Graph- und Powershell-Modul.To learn more, see Important: Azure AD Graph Retirement and Powershell Module Deprecation.

Verfügbare APIs

Alle verfügbaren APIs bei Partnerauszahlungen anzeigen.

Voraussetzungen

Registrieren Sie eine Anwendung mit Microsoft Identity im Azure-Portal, und fügen Sie der Anwendung entsprechende Besitzer und Rollen hinzu.
Installieren Sie Visual Studio.

Registrieren einer Anwendung bei Microsoft Identity Platform

Die Microsoft Identity Platform unterstützt Sie beim Erstellen von Anwendungen, bei denen sich Ihre Benutzer*innen und Kunden mit ihren Microsoft-Identitäten oder Social Media-Konten anmelden können. Außerdem können Sie autorisierten Zugriff auf Ihre eigenen APIs oder Microsoft-APIs wie Microsoft Graph gewähren.

Melden Sie sich mit einem Geschäfts-, Schul- oder Unikonto oder mit einem persönlichen Microsoft-Konto beim Azure-Portal an.

Wenn Ihr Konto Ihnen Zugriff auf mehrere Mandanten gewährt, wählen Sie Ihr Konto in der oberen rechten Ecke aus, und legen Sie Ihre Portalsitzung auf den richtigen Microsoft Entra-Mandanten fest.
Wählen Sie im linken Navigationsbereich den Microsoft Entra-Dienst und dann App-Registrierungen und dann neue Registrierung aus. Die Seite Anwendung registrieren wird angezeigt.

Geben Sie die Registrierungsinformationen Ihrer Anwendung ein:

Name: Geben Sie einen aussagekräftigen Anwendungsnamen ein, der Benutzern der App angezeigt wird.
Unterstützte Kontotypen: Wählen Sie aus, welche Konten Ihre Anwendung unterstützt.

Unterstützte Kontotypen	Beschreibung
Nur Konten in diesem Organisationsverzeichnis	Wählen Sie diese Option aus, wenn Sie eine Branchenanwendung erstellen. Falls Sie die Anwendung nicht in einem Verzeichnis registrieren, ist diese Option nicht verfügbar. Diese Option ist Microsoft Entra-only Einzelmandanten zugeordnet. Sofern Sie die App nicht außerhalb eines Verzeichnisses registrieren, ist dies die Standardoption. In Fällen, in denen die App außerhalb eines Verzeichnisses registriert ist, ist die Standardeinstellung Microsoft Entra Multitenant- und persönliche Microsoft-Konten.
Konten in einem beliebigen Organisationsverzeichnis	Wählen Sie diese Option, wenn Sie alle Kunden aus dem Unternehmens- und Bildungsbereich ansprechen möchten. Diese Option ist einem Microsoft Entra-only-Multitenant zugeordnet. Wenn Sie die App als Nur-Mandant von Microsoft Entra registriert haben, können Sie sie über das Blatt "Authentifizierung" auf "Microsoft Entra multitenant" und zurück zu einem einzelnen Mandanten aktualisieren.
Konten in einem beliebigen Organisationsverzeichnis und persönliche Microsoft-Konten	Wählen Sie diese Option aus, um die meisten Kunden anzusprechen. Diese Option ist microsoft Entra-Mehrinstanzen- und persönlichen Microsoft-Konten zugeordnet. Wenn Sie die App als Microsoft Entra-Multitenant- und persönliche Microsoft-Konten registriert haben, können Sie diese Auswahl in der Benutzeroberfläche nicht ändern. Stattdessen müssen Sie den Anwendungsmanifest-Editor verwenden, um die unterstützten Kontotypen zu ändern.

(optional) Umleitungs-URI: Wählen Sie den Typ der App aus, die Sie erstellen, Web- oder öffentlichen Client (Mobile & Desktop) aus, und geben Sie dann den Umleitungs-URI (oder antwort-URL) für Ihre Anwendung ein. (Die Umleitungs-URL ist der Ort, an dem die Authentifizierungsantwort nach der Authentifizierung des Benutzers gesendet wird.)

Geben Sie für Webanwendungen die Basis-URL Ihrer App an. http://localhost:31544 kann beispielsweise die URL für eine Web-App sein, die auf einem lokalen Computer ausgeführt wird. Benutzer können diese URL nutzen, um sich an einer Webclientanwendung anzumelden. Geben Sie für öffentliche Clientanwendungen den URI an, der von Microsoft Entra ID zum Zurückgeben von Token-Antworten verwendet wird. Geben Sie einen für Ihre Anwendung spezifischen Wert ein (beispielsweise myapp://auth).

Wählen Sie Registrieren aus. Die Microsoft Entra-ID weist Ihrer Anwendung eine eindeutige Anwendungs-ID (Client-ID) zu, und die Übersichtsseite der Anwendung wird geladen.
Wenn Sie Ihrer Anwendung Funktionen hinzufügen möchten, können Sie weitere Konfigurationsoptionen auswählen, darunter Branding, Zertifikate und geheime Schlüssel, API-Berechtigungen und mehr.

Plattformspezifische Eigenschaften

In der folgenden Tabelle sind die Eigenschaften aufgeführt, die Sie für verschiedene Arten von Apps konfigurieren und kopieren müssen. Zugewiesen bedeutet, dass Sie den von microsoft Entra ID zugewiesenen Wert verwenden sollten.

App-Typ	Plattform	Anwendungs-ID (Client)	Geheimer Clientschlüssel	Umleitungs-URI/URL	Impliziter Flow
Systemeigene/mobile Geräte	Systemeigen	Zugewiesen	No	Zugewiesen	No
Web App	Web	Zugewiesen	Ja	Ja	Optionale OpenID-Verbinden Middleware verwendet standardmäßig hybriden Fluss (Ja)
Einzelseiten-App (SPA)	Web	Zugewiesen	Ja	Ja	Ja SPAs verwenden OpenID Verbinden impliziten Fluss
Dienst/Daemon	Web	Zugewiesen	Ja	Ja	No

Erstellen eines Dienstprinzipals

Sie müssen der Anwendung eine Rolle zuweisen, um auf Ressourcen in Ihrem Abonnement zugreifen zu können. Hilfe bei der Entscheidung, welche Rolle die richtigen Berechtigungen für die Anwendung bietet, finden Sie in den integrierten Azure-Rollen.

Hinweis

Sie können den Umfang auf Abonnement-, Ressourcengruppen- oder Ressourcenebene festlegen. Niedrigere Ebenen mit geringerem Umfang erben Berechtigungen. Wenn also beispielsweise der Rolle Leser für eine Ressourcengruppe eine Anwendung hinzugefügt wird, kann diese Rolle die Ressourcengruppe und alle darin enthaltenen Ressourcen lesen.

Wählen Sie im Azure-Portal die Ebene des Bereichs aus, der die Anwendung zugewiesen werden soll. Um beispielsweise eine Rolle im Abonnementbereich zuzuweisen, suchen und wählen Sie "Abonnements" aus, oder wählen Sie "Abonnements" auf der Startseite aus.
Wählen Sie das Abonnement aus, dem die Anwendung zugewiesen werden soll.

Hinweis

Wenn das gesuchte Abonnement nicht angezeigt wird, wählen Sie den globalen Abonnementfilter aus, und stellen Sie sicher, dass das gewünschte Abonnement für das Portal ausgewählt ist.

Wählen Sie Zugriffssteuerung (IAM) und anschließend Rollenzuweisung hinzufügen aus.
Wählen Sie die Rolle aus, die Sie der Anwendung zuweisen möchten. Wählen Sie beispielsweise die Rolle Mitwirkender aus, um für die Anwendung Aktionen wie das Neustarten, Starten und Beenden von Instanzen durchzuführen. Weitere Informationen zu verfügbaren Rollen.

Microsoft Entra-Anwendungen werden standardmäßig nicht in den verfügbaren Optionen angezeigt. Um Ihre Anwendung zu finden, suchen Sie nach dem Namen, und wählen Sie sie aus den Ergebnissen aus. Im folgenden Screenshot sehen Sie die Microsoft Entra-App, example-app die Sie registriert haben.
Wählen Sie Speichern. Anschließend können Sie Ihre Anwendung in der Liste der Benutzer mit einer Rolle für diesen Bereich anzeigen.

Sie können mit der Verwendung Ihres Dienstprinzipals beginnen, um Ihre Skripts oder Apps auszuführen. Um die Berechtigungen Ihres Dienstprinzipals zu verwalten, lesen Sie den Status der Benutzerzustimmung, überprüfen Sie Die Berechtigungen, lesen Sie Anmeldeinformationen und mehr), und zeigen Sie Ihre Unternehmensanwendungen im Azure-Portal an.

Einrichten von API-Berechtigungen

Dieser Abschnitt enthält Anweisungen zum Einrichten der erforderlichen API-Berechtigungen. Weitere Informationen zum Einrichten von Partner Center-API-Berechtigungen finden Sie unter Partner-API-Authentifizierung.

Erteilen der Berechtigung für die Graph-API

Öffnen Sie die App-Registrierungen im Azure-Portal.
Wählen Sie eine Anwendung aus, oder erstellen Sie eine App , wenn Sie noch keines haben.
Wählen Sie auf der Seite "Übersicht" der Anwendung unter "Verwalten" API-Berechtigungen aus, und fügen Sie dann eine Berechtigung hinzu.
Wählen Sie in der Liste der verfügbaren APIs die Option Microsoft Graph aus.
Wählen Sie delegierte Berechtigungen aus, und fügen Sie erforderliche Berechtigungen hinzu. Weitere Informationen finden Sie unter Konfigurieren des App-Zugriffs.

Zustimmung zum API-Zugriff auf die Partner Center-API über die Microsoft Entra-App

Wählen Sie für Ihre Anwendung API-Berechtigungen aus, und wählen Sie dann im Bildschirm "API-Berechtigungen anfordern" die Option "Berechtigung hinzufügen" und dann "APIs" aus, die meine Organisation verwendet.
Suchen Sie nach der Microsoft Partner-API (Microsoft Dev Center) (4990cffe-04e8-4e8b-808a-1175604b879f).
Legen Sie die delegierten Berechtigungen auf Partner Center fest.
Erteilen Der Administratorzustimmung für die APIs.

Überprüfen Sie, ob die Administratorzustimmung im Statusbildschirm "Administratorzustimmung" aktiviert ist.
Stellen Sie im Abschnitt "Authentifizierung " sicher, dass die Option "Öffentliche Clientflüsse zulassen" auf "Ja" festgelegt ist.

Ausführen des Beispielcodes in Visual Studio

Beispielcode, der zeigt, wie die API für den Zahlungs- und Transaktionsverlauf im GitHub-Repository von Partner-Center-Auszahlungs-APIs verwendet werden kann.

Beispielcodenotizen

Konfiguration von geheimen Clientschlüsseln und Zertifikaten, wie im Abschnitt "Authentifizierung" beschrieben: Zwei Optionen im Abschnitt "Erstellen eines Dienstprinzipals" in der Azure-Portal ist nicht erforderlich.
Konten mit mehrstufiger Authentifizierung (MFA) werden derzeit nicht unterstützt und verursachen einen Fehler.
Die Auszahlungs-API unterstützt nur benutzer-/kennwortbasierte Anmeldeinformationen.

Share via