Dokumentacja interfejsu API portalu Cloud Partner

  • Artykuł

Uwaga

Interfejsy API portalu Cloud Partner Portal są zintegrowane z usługą i będą nadal działać w Centrum partnerskim. Przejście wprowadza niewielkie zmiany. Przejrzyj zmiany w interfejsach API CPP wymienionych w tym dokumencie, aby upewnić się, że kod będzie nadal działać po przejściu do Centrum partnerskiego. Interfejsy API CPP powinny być używane tylko dla istniejących produktów, które zostały już zintegrowane przed przejściem do Centrum partnerskiego; nowe produkty powinny używać interfejsów API przesyłania w Centrum partnerskim.

Interfejsy API REST portalu Cloud Partner Portal umożliwiają programowe pobieranie i manipulowanie obciążeniami, ofertami i profilami wydawcy. Interfejsy API używają kontroli dostępu opartej na rolach (RBAC) platformy Azure, aby wymusić poprawne uprawnienia w czasie przetwarzania.

Ta dokumentacja zawiera szczegółowe informacje techniczne dotyczące interfejsów API REST portalu Cloud Partner Portal. Przykłady ładunków w tym dokumencie są przeznaczone tylko do celów referencyjnych i mogą ulec zmianie w miarę dodawania nowych funkcji.

Wymagania wstępne i zagadnienia

Przed rozpoczęciem korzystania z interfejsów API należy przejrzeć następujące elementy:

  • W artykule Wymagania wstępne dowiesz się, jak dodać jednostkę usługi do konta i uzyskać token dostępu firmy Microsoft Entra na potrzeby uwierzytelniania.
  • Dwie strategie sterowania współbieżności dostępne do wywoływania tych interfejsów API.
  • Inne zagadnienia dotyczące interfejsu API, takie jak obsługa wersji i błędów.

Zmiany interfejsów API CPP po migracji do Centrum partnerskiego

API Zmień opis Wpływ
PUBLIKOWANIE POST, GoLive, Anulowanie W przypadku ofert zmigrowanych nagłówek odpowiedzi ma inny format, ale nadal działa w taki sam sposób, oznaczając ścieżkę względną w celu pobrania stanu operacji. Podczas wysyłania dowolnego z odpowiednich żądań POST dla oferty nagłówek Location ma jeden z dwóch formatów w zależności od stanu migracji oferty:
  • Oferty nonmigrated
    /api/operations/{PublisherId}${offerId}$2$preview?api-version=2017-10-31
  • Migrowane oferty
    /api/publishers/{PublisherId}/offers/{offereId}/operations/408a4835-0000-1000-0000-000000000000?api-version=2017-10-31
Operacja GET W przypadku typów ofert, które wcześniej obsługiwały pole "notification-email" w odpowiedzi, to pole będzie przestarzałe i nie zostanie już zwrócone dla zmigrowanych ofert. W przypadku zmigrowanych ofert nie będziemy już wysyłać powiadomień do listy wiadomości e-mail określonych w żądaniach. Zamiast tego usługa interfejsu API jest zgodna z procesem wysyłania wiadomości e-mail z powiadomieniem w Centrum partnerskim w celu wysyłania wiadomości e-mail. W szczególności powiadomienia będą wysyłane na adres e-mail ustawiony w sekcji Informacje kontaktowe sprzedawcy ustawień konta w Centrum partnerskim, aby powiadomić o postępie operacji.

Przejrzyj adres e-mail ustawiony w sekcji Informacje kontaktowe sprzedawcy w ustawieniach konta w Centrum partnerskim, aby upewnić się, że dla powiadomień podano prawidłową wiadomość e-mail.

Typowe zadania

Te szczegółowe informacje o interfejsach API do wykonywania następujących typowych zadań.

Oferty

Operations

Publikowanie aplikacji

Inne zadania

Rozwiązywanie problemów

Wersje i aktualizacje interfejsu API

Aktualizacji Co się zmieniło?
12-2022 Publiczny interfejs API CPP (wersja 2017-10-31) jest teraz aktualizowany w celu przechwytywania identyfikatorów clientId i clientSecret dla łącznika Marketo podczas konfigurowania potencjalnych klientów. Podczas konfiguracji potencjalnych klientów nie musisz podawać pola serverId w przyszłości. Ta aktualizacja interfejsu API nie obejmuje żadnych aktualizacji wersji ani zmian powodujących niezgodność.