Übersicht über die Übermittlungs-API für private Angebote
Private Angebote ermöglichen es Herausgebern und Kunden, Transaktionen für ein einzelnes Produkt oder für mehrere Produkte im Azure Marketplace mit zeitgebundenen Preisen und angepassten Bedingungen zu tätigen. Die APIs für private Angebote ermöglichen Es Herausgebern, private Angebote für Kunden und/oder CSP-Partner programmgesteuert zu erstellen und zu verwalten. Diese API verwendet Die Microsoft Entra-ID, um die Aufrufe von Ihrer App oder Ihrem Dienst zu authentifizieren.
Im Partner Center stehen drei Haupttypen privater Angebote zur Verfügung und werden von der API für die Übermittlung privater Angebote unterstützt:
- ISV zum privaten Kundenangebot – auch als privates Kundenangebot im Partner Center bezeichnet. Dies ist ein benutzerdefinierter Deal zwischen einem ISV und einem bestimmten Kunden mit angepassten Bedingungen und Preisen für ein bestimmtes Produkt in Azure Marketplace. Erfahren Sie mehr über ISV zum Kunden-Privatangebot.
- ISV zu CSP-Partner privates Angebot – auch als privates CSP-Partnerangebot im Partner Center bezeichnet. Diese Art von privatem Angebot ermöglicht es ISV, zeitgebundene Marge anzugeben, um einen Großhandelspreis für ihren CSP-Partner zu erstellen. Erfahren Sie mehr über ISV zu CSP-Partner-Private-Angebot.
- Privates Angebot mit mehreren Teilnehmern (MPO) – Ein von einem ISV gemeinsam konfigurierter benutzerdefinierter Deal und ein bevorzugter Kanalpartner eines bestimmten Kunden mit angepassten Bedingungen und Preisen für bestimmte Produkte in Azure Marketplace. Der ISV definiert den ermäßigten Großhandelspreis, der dem Partner zur Verfügung gestellt wird, der Kanalpartner kann dann Markup über den Großhandelspreis hinzufügen, um zum Endkundenpreis zu gelangen und dem Kunden das Angebot zur Annahme und zum Kauf zu präsentieren. Die Annahme und der Kauf des MPO folgt demselben Fluss wie ISV zu Kunden-Privatangeboten. Erfahren Sie mehr über das private Angebot mit mehreren Teilnehmern.
Terminologie
- MPO-Absender – MPO ist eine Zusammenarbeit zwischen ISV und Kanalpartner auf demselben benutzerdefinierten Deal für einen bestimmten Kunden, die zuerst das MPO erstellt, wird als "Absender " des Angebots bezeichnet, in der Regel der ISV der Produkte, die im MPO enthalten sind. Es kann nur ein Absender für ein bestimmtes MPO vorhanden sein.
- MPO-Verkäufer – Der Kanalpartner, der das Angebot mit dem Endkundenpreis vorbereitet und dem Kunden das Angebot präsentiert, ist der Verkäufer des MPO. Es kann nur ein Verkäufer für ein bestimmtes MPO vorhanden sein.
- Produkt: Eine einzelne Einheit, die ein Angebot in Azure Marketplace darstellt. Pro Auflistungsseite gibt es ein Produkt.
- Plan: Eine einzelne Version eines bestimmten Produkts. Es kann mehrere Pläne für ein bestimmtes Produkt geben, die verschiedene Preise oder Bedingungen darstellen.
- Auftrag: Eine Aufgabe, die beim Senden einer Anforderung in dieser API erstellt wird. Wenn Sie diese API zum Verwalten privater Angebote und privater Angebote mit mehreren Teilnehmern verwenden, wird ein Auftrag erstellt, um die Anforderung abzuschließen. Sobald der Auftrag abgeschlossen ist, erhalten Sie weitere Informationen über das relevante private Angebot (Mehrparteien).
Unterstützte Szenarios
- Erstellen eines privaten Angebots für einen Kunden
- Erstellen eines privaten Angebots für einen Händler
- Erstellen eines privaten Mehrparteienangebots für einen Kunden
- Löschen eines privaten Angebots
- Zurückziehen eines privaten Angebots
- Abfragen einer Liste privater Angebote mit mehreren Teilnehmern
- Abfragen einer Liste von Produkten und Plänen
Vorbereiten der Verwendung dieser API
Bevor Sie Code zum Aufrufen der API für private Angebote schreiben, müssen Sie sicherstellen, dass die folgenden Voraussetzungen erfüllt sind. Die gleichen Voraussetzungen gelten für alle Veröffentlichungspartner.
Schritt 1: Erfüllen der Voraussetzungen für die Verwendung der Microsoft Product Ingestion-API (einmalig)
Sie oder Ihre Organisation müssen über eine Microsoft Entra-Verzeichnis- und globale Administratorberechtigung verfügen. Wenn Sie Microsoft 365 oder andere Geschäftsdienste bereits von Microsoft verwenden, verfügen Sie bereits über das Microsoft Entra-Verzeichnis. Wenn nicht, können Sie eine neue Microsoft Entra-ID im Partner Center kostenlos erstellen.
Sie müssen ihrer Partner Center-Konto eine Microsoft Entra-ID-Anwendung zuordnen und Ihre Mandanten-ID, Client-ID und Ihren Schlüssel abrufen. Sie benötigen diese Werte, um das Microsoft Entra-Zugriffstoken abzurufen, das Sie in Aufrufen der privaten Angebots-API verwenden.
Schritt 2: Abrufen eines Microsoft Entra-Zugriffstokens (jedes Mal)
Bevor Sie eine der Methoden in der Microsoft Store-Übermittlungs-API aufrufen, benötigen Sie ein Microsoft Entra-Zugriffstoken, um den Autorisierungsheader jeder Methode in der API zu übergeben. Sie haben 60 Minuten Zeit, ein Token zu verwenden, bevor es abläuft. Nach Ablauf eines Tokens können Sie es aktualisieren, damit es in weiteren Aufrufen der API verwendet werden kann.
Folgen Sie zum Abrufen des Zugriffstokens den Anweisungen unter Dienst-zu-Dienst-Aufrufe mit Clientanmeldeinformationen, um eine HTTP POST-Anforderung an den Endpunkt https://login.microsoftonline.com/<tenant_id>/oauth2/token zu senden. Hier sehen Sie eine Beispielanforderung:
POST https://login.microsoftonline.com/<tenant_id>/oauth2/token HTTP/1.1
Host: login.microsoftonline.com
Content-Type: application/x-www-form-urlencoded; charset=utf-8
grant_type=client_credentials
&client_id=<your_client_id>
&client_secret=<your_client_secret>
&resource=https://graph.microsoft.com/
Geben Sie für den Wert „tenant_id“ im POST-URI sowie für die Parameter „client_id“ und „client_secret“ die Mandanten-ID, die Client-ID und den Schlüssel für die Anwendung an, die Sie im vorherigen Abschnitt aus Partner Center abgerufen haben. Für den Ressourcenparameter müssen Sie angeben https://graph.microsoft.com/.
Ermitteln der IDs von Produkten, Plänen und privaten Angeboten
| ID | Wo finde ich sie? |
|---|---|
| client_id | Siehe Zuordnen einer Microsoft Entra-Anwendung zu Ihrem Partner Center-Konto. |
| tenant_id | Siehe Zuordnen einer Microsoft Entra-Anwendung zu Ihrem Partner Center-Konto. |
| client_secret | Siehe Zuordnen einer Microsoft Entra-Anwendung zu Ihrem Partner Center-Konto. |
| productId | Weitere Informationen finden Sie unter Abrufen von Produkten in diesem Artikel. |
| planId | Siehe Abrufen von Plänen für ein bestimmtes Produkt in diesem Artikel. |
| privateofferId | Weitere Informationen finden Sie unter Abrufen privater Angebote in diesem Artikel. |
Abrufen von Produkten
Ein privates Angebot basiert auf einem vorhandenen Produkt in Ihrem Partner Center-Konto. Verwenden Sie den folgenden API-Aufruf, um eine Liste der Ihrem Partner Center-Konto zugeordneten Produkte anzuzeigen:
GET https://graph.microsoft.com/rp/product-ingestion/product?$version=2022-07-01
Die Antwort wird im folgenden Beispielformat angezeigt:
{
"value": [
{
"$schema": "https://schema.mp.microsoft.com/schema/product/2022-07-01",
"id": "string",
"identity": {
"externalId": "string"
},
"type": "enum",
"alias": "string"
}
],
"@nextLink": "opaque_uri"
}
Abrufen von Plänen für ein bestimmtes Produkt
Für Produkte, die mehr als einen Plan enthalten, können Sie ein privates Angebot basierend auf einem bestimmten Plan erstellen. Wenn ja, benötigen Sie die ID dieses Plans. Rufen Sie mithilfe des folgenden API-Aufrufs eine Liste der Pläne (z. B. Varianten oder SKUs) für das Produkt ab:
GET https://graph.microsoft.com/rp/product-ingestion/plan?product=<product-id>&$version=2022-07-01
Die Antwort wird im folgenden Beispielformat angezeigt:
{
"value": [
{
"$schema": "https://schema.mp.microsoft.com/schema/plan/2022-07-01",
"product": "string",
"id": "string",
"identity": {
"externalId": "string"
},
"alias": "string"
}
]
}
Abrufen von privaten Angeboten
Um eine Liste aller privaten Angebote anzuzeigen, einschließlich privater Angebote mit mehreren Teilnehmern, die Ihrem Konto zugeordnet sind, verwenden Sie den folgenden API-Aufruf:
GET https://graph.microsoft.com/rp/product-ingestion/private-offer/query?$version=2023-07-15
Verwenden der API
Mit der api für private Angebote können Sie private Angebote erstellen und verwalten, die mit Produkten und Plänen in Ihrem Partner Center-Konto verknüpft sind. Nachfolgend finden Sie eine Zusammenfassung des typischen Aufrufmusters beim Verwenden dieser API.
Schritt 1: Anforderung stellen
Wenn Sie einen API-Aufruf zum Erstellen, Löschen, Zurückziehen oder Upgraden eines privaten Angebots senden, wird ein neuer Auftrag erstellt, um die angeforderte Aufgabe abzuschließen. Die API-Antwort enthält eine jobId, die dem Auftrag zugeordnet ist.
Schritt 2: Abrufen des Auftragsstatus
Rufen Sie mithilfe der jobId aus der anfänglichen API-Antwort ab, um den Auftragsstatus abzurufen. Der Status des Auftrags wird entweder ausgeführt oder abgeschlossen. Nachdem der Auftrag abgeschlossen wurde, wird das Ergebnis entweder erfolgreich oder fehlgeschlagen. Fragen Sie einen Auftrag nicht öfter als einmal pro Minute ab, um Leistungsprobleme zu vermeiden.
| jobStatus | Beschreibung |
|---|---|
| NotStarted | Der Auftrag wurde noch nicht gestartet. Dies ist Teil der Antwort auf die erste Anforderung. |
| Wird ausgeführt | Der Auftrag wird noch ausgeführt. |
| Abgeschlossen | Der Auftrag wurde abgeschlossen. Weitere Informationen finden Sie unter jobResult . |
| jobResult | Beschreibung |
| Ausstehend | Der Auftrag wurde noch nicht abgeschlossen. |
| Erfolgreich | Der Auftrag wurde erfolgreich abgeschlossen. Dieser Auftrag gibt auch einen Ressourcen-URI zurück, der auf das private Angebot im Zusammenhang mit dem Auftrag verweist. Verwenden Sie diesen Ressourcen-URI, um die vollständigen Details eines privaten Angebots abzurufen. |
| Fehler | Der Auftrag ist fehlgeschlagen. Dies gibt auch alle relevanten Fehler zurück, um die Ursache des Fehlers zu ermitteln. |
Weitere Informationen finden Sie unter Abfragen des Status eines vorhandenen Auftrags.
Schritt 3: Abrufen von Informationen aus abgeschlossenen Aufträgen
Ein erfolgreicher Auftrag gibt einen resourceUri zurück, der auf das entsprechende private Angebot verweist. Verwenden Sie diesen Ressourcen-URI, um in Zukunft weitere Details zum privaten Angebot zu erhalten, wie z. B. die privateofferId.
Ein fehlgeschlagener Auftrag enthält Fehler, die Details dazu liefern, warum der Auftrag fehlgeschlagen ist und wie das Problem behoben werden kann.
Weitere Informationen finden Sie unter Abrufen von Details zu einem vorhandenen privaten Angebot.
Wie ISV und Kanalpartner die API für privates Angebot mit mehreren Teilnehmern gemeinsam nutzen sollten
Sowohl ISV als auch Kanalpartner können die gleichen APIs zum Erstellen und Verwalten eines bestimmten MPO verwenden. Ressourcen in einem MPO, die sich auf die API auswirken können, hängen jedoch davon ab, ob der Aufrufer der API der ISV (Absender) oder der Kanalpartner (Verkäufer) des MPO ist. Der gleiche ISV/Channel Partner Publishing Flow und Geschäftsregeln für Partner Center werden in der API gespiegelt. Hier ist eine Übersicht:
| API-Vorgang | ISV (Absender) | Kanalpartner (Verkäufer) |
|---|---|---|
| Erstellen |
|
|
| Löschen |
|
|
| Zurückziehen |
|
|