Cloud-Partnerportal-API-Referenz

  • Artikel

Hinweis

Die Cloud-Partnerportal-APIs sind in Partner Center integriert und funktionieren auch weiterhin. Der Übergang führt zu kleineren Änderungen. Beachten Sie die in diesem Dokument aufgeführten Änderungen an CCP-APIs, um sicherzustellen, dass Ihr Code nach dem Produktübergang zu Partner Center weiterhin funktioniert. CPP-APIs sollten nur für vorhandene Produkte verwendet werden, die bereits vor dem Übergang zu Partner Center integriert wurden. Neue Produkte sollten die Partner Center-APIs für die Übermittlung verwenden.

Die Cloud-Partnerportal-REST-APIs ermöglichen programmgesteuertes Abrufen und Bearbeiten von Workloads, Angeboten und Herausgeberprofilen. In den APIs wird rollenbasierte Zugriffssteuerung von Azure (Azure Role-Based Access Control, Azure RBAC) verwendet, um die richtigen Berechtigungen während der Verarbeitungszeit zu erzwingen.

Diese Referenz enthält die technischen Details für die Cloud-Partnerportal-REST-APIs. Die Nutzlastbeispiele in diesem Dokument dienen nur zu Referenzzwecken und können geändert werden, wenn neue Funktionalität hinzugefügt wurde.

Voraussetzungen und Überlegungen

Bevor Sie die APIs verwenden, sollten Sie sich Folgendes ansehen:

  • Im Artikel "Voraussetzungen" erfahren Sie, wie Sie Ihrem Konto einen Dienstprinzipal hinzufügen und ein Microsoft Entra-Zugriffstoken für die Authentifizierung erhalten.
  • Die beiden Strategien zur Steuerung der Parallelität, die zum Aufrufen dieser APIs verfügbar sind.
  • Andere API-Überlegungen, z. B. Versionsverwaltung und Fehlerbehandlung.

Änderungen an CPP-APIs nach der Migration zu Partner Center

API Beschreibung der Änderung Auswirkung
POST Publish, GoLive, Cancel Für migrierte Angebote weist der Antwortheader ein anderes Format auf, funktioniert aber weiterhin auf die gleiche Weise, wobei ein relativer Pfad zum Abrufen des Vorgangsstatus angegeben wird. Beim Senden einer der entsprechenden POST-Anforderungen für ein Angebot weist der Location-Header je nach Migrationsstatus des Angebots ein von zwei Formaten auf:
  • Nicht migrierte Angebote
    /api/operations/{PublisherId}${offerId}$2$preview?api-version=2017-10-31
  • Migrierte Angebote
    /api/publishers/{PublisherId}/offers/{offereId}/operations/408a4835-0000-1000-0000-000000000000?api-version=2017-10-31
GET-Vorgang Bei Angebotstypen, die zuvor das Feld „Benachrichtigungs-E-Mail“ in der Antwort unterstützten, wird dieses Feld entfernt und für migrierte Angebote nicht mehr zurückgegeben. Bei migrierten Angeboten werden keine Benachrichtigungen mehr an die Liste der in den Anforderungen angegebenen E-Mail-Adressen gesendet. Stattdessen richtet sich der API-Dienst an den Benachrichtigungs-E-Mail-Prozess im Partner Center, um E-Mails zu senden. Insbesondere werden Benachrichtigungen an die E-Mail-Adresse gesendet, die in Partner Center in Ihren Kontoeinstellungen im Abschnitt der Kontaktinformationen des Verkäufers festgelegt wurde, um Sie über den Fortschritt des Vorgangs zu benachrichtigen.

Überprüfen Sie die E-Mail-Adresse, die im Abschnitt "Kontaktinformationen des Verkäufers" Ihrer Kontoeinstellungen im Partner Center festgelegt ist, um sicherzustellen, dass die richtige E-Mail für Benachrichtigungen bereitgestellt wird.

Häufige Aufgaben

In dieser Referenz werden APIs ausführlich erläutert, mit denen die folgenden üblichen Aufgaben ausgeführt werden können.

Angebote

Vorgänge

Veröffentlichen einer App

Weitere Aufgaben

Problembehandlung

API-Versionen und -Updates

Aktualisieren von Was hat sich geändert?
12-2022 Die öffentliche CPP-API (Version 2017-10-31) wird jetzt aktualisiert, um clientId und clientSecret für Marketo-Connector beim Konfigurieren von Kundenkontakten zu erfassen. Während der Leadkonfiguration müssen Sie das ServerId-Feld in Zukunft nicht bereitstellen. Dieses Update für die API umfasst keine Versionsupdates oder unterbrechungsrelevante Änderungen.