Zarządzanie wypłatami przy użyciu interfejsu API usługi wypłaty

W tym artykule wyjaśniono, jak uzyskać dostęp do danych wypłat za pośrednictwem interfejsów API usługi wypłaty zamiast interfejsu użytkownika Centrum partnerskiego. Te interfejsy API zapewniają programowy sposób zapewniania możliwości funkcji Eksportowanie danych w Centrum partnerskim.

Ważne

Usługa Azure Active Directory (Azure AD) Graph jest przestarzała od 30 czerwca 2023 r. W przyszłości nie dokonujemy dalszych inwestycji w usłudze Azure AD Graph. Interfejsy API programu Graph usługi Azure AD nie mają umowy SLA ani zobowiązania do konserwacji poza poprawkami związanymi z zabezpieczeniami. Inwestycje w nowe funkcje i funkcje zostaną dokonane tylko w programie Microsoft Graph.

Wycofamy program Azure AD Graph w krokach przyrostowych, aby mieć wystarczający czas na migrację aplikacji do interfejsów API programu Microsoft Graph. W późniejszym terminie ogłosimy, że zablokujemy tworzenie nowych aplikacji przy użyciu usługi Azure AD Graph.

Aby dowiedzieć się więcej, zobacz Ważne: wycofanie programu Azure AD Graph i wycofanie modułu powershell.

Dostępne interfejsy API

Zobacz wszystkie dostępne interfejsy API na stronie Wypłaty partnerów.

Wymagania wstępne

• Zarejestruj aplikację przy użyciu usługi Microsoft Identity w witrynie Azure Portal i dodaj odpowiednich właścicieli i ról do aplikacji.
• Zainstalować program Visual Studio.

Rejestrowanie aplikacji za pomocą platformy tożsamości firmy Microsoft

Platforma tożsamości Microsoft ułatwia tworzenie aplikacji, do których użytkownicy i klienci mogą logować się przy użyciu tożsamości firmy Microsoft lub kont społecznościowych, oraz zapewnić autoryzowany dostęp do własnych interfejsów API lub interfejsów API firmy Microsoft, takich jak Microsoft Graph.

1. Zaloguj się do witryny Azure Portal przy użyciu służbowego lub osobistego konta Microsoft.

   Jeśli Twoje konto zapewnia dostęp do więcej niż jednej dzierżawy, wybierz swoje konto w prawym górnym rogu i ustaw sesję portalu na poprawną dzierżawę firmy Microsoft Entra.

2. W okienku nawigacji po lewej stronie wybierz usługę Microsoft Entra, a następnie Rejestracje aplikacji, a następnie pozycję Nowa rejestracja. Zostanie wyświetlona strona Rejestrowanie aplikacji .

3. Wprowadź informacje o rejestracji aplikacji:

   • Nazwa: wprowadź zrozumiałą nazwę aplikacji, która będzie wyświetlana użytkownikom aplikacji.
   • Obsługiwane typy kont: wybierz konta, które będą obsługiwane przez twoją aplikację.

   Obsługiwane typy kont	Opis
   Tylko konta w tym katalogu organizacyjnym	Wybierz tę opcję, jeśli kompilujesz aplikację biznesową. Ta opcja nie jest dostępna, jeśli nie rejestrujesz aplikacji w katalogu. Ta opcja mapuje na usługę Microsoft Entra-only single-tenant. Ta opcja jest domyślna, chyba że rejestrujesz aplikację poza katalogiem. W przypadkach, gdy aplikacja jest zarejestrowana poza katalogiem, wartość domyślna to Microsoft Entra multitenant i osobiste konta Microsoft.
   Konta w dowolnym katalogu organizacyjnym	Wybierz tę opcję, jeśli aplikacja jest przeznaczona dla wszystkich klientów biznesowych i edukacyjnych. Ta opcja mapuje na wielodostępne tylko firmy Microsoft. Jeśli aplikacja została zarejestrowana jako tylko jedna dzierżawa firmy Microsoft, możesz ją zaktualizować tak, aby była wielodostępna i z powrotem do jednej dzierżawy za pomocą bloku Uwierzytelnianie.
   Konta w dowolnym katalogu organizacyjnym i osobiste konta Microsoft	Wybierz tę opcję, aby kierować aplikację do najszerszego grona odbiorców. Ta opcja mapuje na konta Microsoft Entra multitenant i osobiste konta Microsoft. Jeśli zarejestrowano aplikację jako wielodostępne i osobiste konta Microsoft Firmy Microsoft, nie możesz zmienić tego wyboru w interfejsie użytkownika. Zamiast tego do zmiany obsługiwanych typów kont należy użyć edytora manifestów aplikacji.

   • (opcjonalnie) Identyfikator URI przekierowania: wybierz typ kompilowania aplikacji, klienta internetowego lub publicznego (mobilnego i klasycznego), a następnie wprowadź identyfikator URI przekierowania (lub adres URL odpowiedzi) dla aplikacji. (Adres URL przekierowania to miejsce, w którym po uwierzytelnieniu użytkownika zostanie wysłana odpowiedź uwierzytelniania).

     W przypadku aplikacji internetowej podaj podstawowy adres URL aplikacji. Na przykład ciąg http://localhost:31544 może być adresem URL aplikacji internetowej uruchomionej na komputerze lokalnym. Użytkownicy mogą użyć tego adresu URL, aby zalogować się do aplikacji klienta internetowego. W przypadku aplikacji klienckich publicznych podaj identyfikator URI używany przez firmę Microsoft Entra ID do zwracania odpowiedzi tokenu. Podaj wartość specyficzną dla Twojej aplikacji, np. myapp://auth.

4. Wybierz pozycję Zarejestruj. Identyfikator entra firmy Microsoft przypisuje unikatowy identyfikator aplikacji (klienta) do aplikacji, a strona przeglądu aplikacji zostanie załadowana.

5. Jeśli chcesz dodać możliwości do aplikacji, możesz wybrać inne opcje konfiguracji, takie jak znakowanie, certyfikaty i wpisy tajne, uprawnienia interfejsu API i inne.

Właściwości specyficzne dla platformy

W poniższej tabeli przedstawiono właściwości, które należy skonfigurować i skopiować dla różnych rodzajów aplikacji. Przypisano oznacza, że należy użyć wartości przypisanej przez identyfikator Firmy Microsoft Entra.

Typ aplikacji	Platforma	Identyfikator aplikacji (klient)	Klucz tajny klienta	Identyfikator URI/adres URL przekierowania	Przepływ niejawny
Natywna/mobilna	Macierzyste	Przypisane	Nie.	Przypisane	Nie.
Aplikacja internetowa	Internet	Przypisane	Tak	Tak	Opcjonalne oprogramowanie pośredniczące OpenID Connect domyślnie używa przepływu hybrydowego (Tak)
Aplikacja jednostronicowa (SPA)	Internet	Przypisane	Tak	Tak	Tak dostawcy usług używają niejawnego przepływu OpenID Connect
Usługa/Demon	Internet	Przypisane	Tak	Tak	Nie.

Tworzenie jednostki usługi

Aby uzyskać dostęp do zasobów w ramach subskrypcji, musisz przypisać rolę do aplikacji. Aby uzyskać pomoc przy podejmowaniu decyzji, która rola oferuje odpowiednie uprawnienia dla aplikacji, zobacz Role wbudowane platformy Azure.

Uwaga

Zakres można ustawić na poziomie subskrypcji, grupy zasobów lub zasobu. Uprawnienia są dziedziczone do niższych poziomów zakresu. Na przykład dodanie aplikacji do roli Czytelnik dla grupy zasobów oznacza, że może odczytać grupę zasobów i wszystkie zawarte w niej zasoby.

1. W witrynie Azure Portal wybierz poziom zakresu, do których ma zostać przypisana aplikacja. Aby na przykład przypisać rolę w zakresie subskrypcji, wyszukaj i wybierz pozycję Subskrypcje lub wybierz pozycję Subskrypcje na stronie głównej.

   

2. Wybierz subskrypcję, do których chcesz przypisać aplikację.

   

   Uwaga

   Jeśli nie widzisz żądanej subskrypcji, wybierz filtr subskrypcji globalnych i upewnij się, że wybrana subskrypcja jest wybrana dla portalu.

3. Wybierz opcję Kontrola dostępu (IAM), a następnie wybierz opcję Dodaj przypisanie roli.

4. Wybierz rolę, którą chcesz przypisać do aplikacji. Aby na przykład umożliwić aplikacji wykonywanie akcji, takich jak ponowne uruchomienie, uruchamianie i zatrzymywanie wystąpień, wybierz rolę Współautor. Przeczytaj więcej na temat dostępnych ról.

   Domyślnie aplikacje Firmy Microsoft Entra nie są wyświetlane w dostępnych opcjach. Aby znaleźć aplikację, wyszukaj nazwę i wybierz ją z wyników. Na poniższym zrzucie ekranu example-app znajduje się zarejestrowana aplikacja Firmy Microsoft Entra.

5. Wybierz pozycję Zapisz. Następnie możesz wyświetlić swoją aplikację na liście użytkowników z rolą dla tego zakresu.

   Możesz zacząć używać jednostki usługi do uruchamiania skryptów lub aplikacji. Aby zarządzać uprawnieniami jednostki usługi, zobacz stan zgody użytkownika, przejrzyj uprawnienia, zobacz informacje o logowaniu i nie tylko), wyświetl aplikacje dla przedsiębiorstw w witrynie Azure Portal.

Konfigurowanie uprawnień interfejsu API

Ta sekcja zawiera instrukcje dotyczące konfigurowania wymaganych uprawnień interfejsu API. Aby uzyskać więcej informacji na temat konfigurowania uprawnień interfejsu API Centrum partnerskiego, zobacz Uwierzytelnianie interfejsu API partnera.

Udzielanie uprawnień do interfejsu API programu Graph

1. Otwórz Rejestracje aplikacji w witrynie Azure Portal.

2. Wybierz aplikację lub utwórz aplikację , jeśli jeszcze jej nie masz.

3. Na stronie Przegląd aplikacji w obszarze Zarządzanie wybierz pozycję Uprawnienia interfejsu API, a następnie dodaj uprawnienie.

4. Wybierz pozycję Microsoft Graph z listy dostępnych interfejsów API.

5. Wybierz pozycję Uprawnienia delegowane i dodaj wymagane uprawnienia. Aby uzyskać więcej informacji, zobacz Konfigurowanie dostępu do aplikacji.

   

   Zgoda na dostęp interfejsu API do interfejsu API Centrum partnerskiego za pośrednictwem aplikacji Microsoft Entra

6. W przypadku aplikacji wybierz pozycję Uprawnienia interfejsu API, a następnie na ekranie Zażądaj uprawnień interfejsu API wybierz pozycję Dodaj uprawnienie, a następnie interfejsy API używane przez moją organizację.

7. Wyszukaj interfejs API Microsoft Partner (Microsoft Centrum deweloperów) (4990cffe-04e8-4e8b-808a-1175604b879f).

   

8. Ustaw uprawnienia delegowane na Centrum partnerskie.

   

9. Udziel zgody administratora dla interfejsów API.

   

   Sprawdź, czy zgoda administratora jest włączona na ekranie Stan zgody administratora.

   

10. W sekcji Uwierzytelnianie upewnij się, że opcja Zezwalaj na przepływy klientów publicznych ma wartość Tak.

Uruchamianie przykładowego kodu w programie Visual Studio

Przykładowy kod pokazujący, jak interfejs API może być używany do obsługi płatności i historii transakcji, można znaleźć w repozytorium GitHub Partner-Center-Payout-APIs .

Przykładowe uwagi dotyczące kodu

• Konfiguracja wpisów tajnych klienta i certyfikatów zgodnie z opisem w sekcji Uwierzytelnianie: Dwie opcje w temacie Jak utworzyć jednostkę usługi w witrynie Azure Portal nie jest wymagane.
• Konta z uwierzytelnianiem wieloskładnikowym (MFA) nie są obecnie obsługiwane i spowodują błąd.
• Interfejs API wypłat obsługuje tylko poświadczenia oparte na użytkownikach/hasłach.

Powiązana zawartość

• Użyj portalu, aby utworzyć aplikację Firmy Microsoft Entra i jednostkę usługi, która może uzyskiwać dostęp do zasobów
• Rejestrowanie aplikacji za pomocą platformy tożsamości firmy Microsoft
• Konfigurowanie aplikacji klienckiej w celu uzyskania dostępu do internetowego interfejsu API