Delen via

Overzicht van de API voor het indienen van privéaanbiedingen

  • Artikel

Met privéaanbiedingen kunnen uitgevers en klanten een of meer producten in Azure Marketplace verwerken door tijdgebonden prijzen te maken met aangepaste voorwaarden. Met de API's voor het indienen van privéaanbiedingen kunnen uitgevers programmatisch privéaanbiedingen maken en beheren voor klanten en/of CSP-partners. Deze API maakt gebruik van Microsoft Entra ID om de aanroepen van uw app of service te verifiëren.

Er zijn drie hoofdtypen privéaanbiedingen beschikbaar in partnercentrum en worden ondersteund door de API voor het indienen van privéaanbiedingen:

  • ISV aan klant privéaanbieding – ook wel klant-privéaanbieding in partnercentrum aangeduid. Dit is een aangepaste deal tussen een ISV en een specifieke klant met aangepaste voorwaarden en prijzen voor een specifiek product in Azure Marketplace. Meer informatie over ISV voor persoonlijke aanbiedingen van klanten.
  • Privéaanbieding van ISV naar CSP-partner : ook wel CSP Partners-privéaanbieding in partnercentrum aangeduid. Met dit type privéaanbieding kan ISV een tijdgebonden marge opgeven om een groothandelsprijs te maken voor hun CSP-partner. Meer informatie over privéaanbieding van ISV naar CSP-partner.
  • Multiparty Private Offer (MPO): een aangepaste deal die is geconfigureerd door een ISV en een voorkeurskanaalpartner van een specifieke klant met aangepaste voorwaarden en prijzen voor specifieke producten in Azure Marketplace. De ISV definieert de gereduceerde groothandelsprijs die beschikbaar wordt gesteld aan de partner, de kanaalpartner kan vervolgens markeringen toevoegen aan de groothandelsprijs om aan de uiteindelijke klantprijs te komen en de aanbieding aan de klant voor acceptatie en aankoop presenteert. Acceptatie en aankoop van de MPO volgt dezelfde stroom als ISV voor persoonlijke aanbiedingen van klanten. Meer informatie over een privéaanbieding met meerdere partijen.

Terminologie

  • MPO-originator - MPO is een samenwerking tussen ISV en kanaalpartner voor dezelfde aangepaste deal voor een specifieke klant, de partij die de MPO voor het eerst maakt, wordt aangewezen als de 'originator' van de aanbieding, meestal de ISV van de producten die zijn opgenomen in de MPO. Er kan slechts één originator zijn voor een bepaalde MPO.
  • MPO-verkoper : de kanaalpartner die de aanbieding voorbereidt met de uiteindelijke klantprijs en de aanbieding aan de klant presenteert, is de verkoper van de MPO. Er kan slechts één verkoper zijn voor een bepaalde MPO.
  • Product : één eenheid die een aanbieding vertegenwoordigt in Azure Marketplace. Er is één product per vermeldingspagina.
  • Plan : één versie van een bepaald product. Er kunnen meerdere abonnementen zijn voor een bepaald product dat verschillende prijsniveaus of voorwaarden vertegenwoordigt.
  • Taak : een taak die is gemaakt bij het indienen van een aanvraag in deze API. Wanneer u deze API gebruikt om privéaanbiedingen en privéaanbiedingen met meerdere partijen te beheren, wordt er een taak gemaakt om de aanvraag te voltooien. Zodra de taak is voltooid, kunt u meer informatie krijgen over de relevante (multiparty) privéaanbieding.

Ondersteunde scenario's

Bereid u voor op het gebruik van deze API

Voordat u code schrijft om de API voor privéaanbiedingen aan te roepen, moet u ervoor zorgen dat u aan de volgende vereisten voldoet. Dezelfde vereisten gelden voor alle publicerende partners.

Stap 1: Voltooi de vereisten voor het gebruik van de Microsoft ProductOpname-API (eenmalig)

U of uw organisatie moet beschikken over een Microsoft Entra-directory en globale beheerdersmachtigingen. Als u Al Microsoft 365 of andere zakelijke services van Microsoft gebruikt, hebt u al de directory Microsoft Entra. Zo niet, dan kunt u gratis een nieuwe Microsoft Entra-id maken in partnercentrum.

U moet een Microsoft Entra ID-toepassing koppelen aan uw Partnercentrum-account en uw tenant-id, client-id en -sleutel verkrijgen. U hebt deze waarden nodig om het Microsoft Entra-toegangstoken te verkrijgen dat u gaat gebruiken in aanroepen naar de API voor persoonlijke aanbiedingen.

Stap 2: een Microsoft Entra-toegangstoken verkrijgen (elke keer)

Voordat u een van de methoden aanroept in de Microsoft Store-indienings-API, hebt u een Microsoft Entra-toegangstoken nodig om door te geven aan de autorisatieheader van elke methode in de API. U hebt 60 minuten om een token te gebruiken voordat het verloopt. Na verloop van tijd kunt u een token vernieuwen, zodat u het kunt blijven gebruiken in verdere aanroepen naar de API.

Zie Service to Service-aanroepen met behulp van clientreferenties om een HTTP POST te verzenden naar het https://login.microsoftonline.com/<eindpunt tenant_id>/oauth2/token om het toegangstoken te verkrijgen. Hier volgt een voorbeeldaanvraag:

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/

Geef voor de tenant_id waarde in de POST-URI en de parameters client_id en client_secret de tenant-id, client-id en sleutel op voor uw toepassing die u in de vorige sectie hebt opgehaald uit het Partnercentrum. Voor de resourceparameter moet u opgeven https://graph.microsoft.com/.

Product-, plan- en privéaanbiedings-id's zoeken

Id Waar u ze kunt vinden
client_id Zie Een Microsoft Entra-toepassing koppelen aan uw Partnercentrum-account.
tenant_id Zie Een Microsoft Entra-toepassing koppelen aan uw Partnercentrum-account.
client_secret Zie Een Microsoft Entra-toepassing koppelen aan uw Partnercentrum-account.
productId Zie Producten ophalen in dit artikel.
planId Zie Plannen ophalen voor een specifiek product in dit artikel.
privateofferId Zie Privéaanbiedingen ophalen in dit artikel.

Producten ophalen

Een privéaanbieding is gebaseerd op een bestaand product in uw Partnercentrum-account. Gebruik deze API-aanroep voor een lijst met producten die zijn gekoppeld aan uw Partnercentrum-account:

GET https://graph.microsoft.com/rp/product-ingestion/product?$version=2022-07-01

Het antwoord wordt weergegeven in de volgende voorbeeldindeling:

{
  "value": [
    {
      "$schema": "https://schema.mp.microsoft.com/schema/product/2022-07-01",
      "id": "string",
      "identity": {
        "externalId": "string"
      },
      "type": "enum",
      "alias": "string"
    }
  ],
  "@nextLink": "opaque_uri"
}

Plannen voor een specifiek product ophalen

Voor producten die meer dan één abonnement bevatten, wilt u mogelijk een privéaanbieding maken op basis van één specifiek abonnement. Zo ja, dan hebt u de id van dat plan nodig. Haal een lijst op met de plannen (zoals varianten of SKU's) voor het product met behulp van de volgende API-aanroep:

GET https://graph.microsoft.com/rp/product-ingestion/plan?product=<product-id>&$version=2022-07-01

Het antwoord wordt weergegeven in de volgende voorbeeldindeling:

{
  "value": [
    {
      "$schema": "https://schema.mp.microsoft.com/schema/plan/2022-07-01",
      "product": "string",
      "id": "string",
      "identity": {
        "externalId": "string"
      },
      "alias": "string"
    }
  ]
}

Privéaanbiedingen ophalen

Gebruik de volgende API-aanroep om een lijst weer te geven van alle privéaanbiedingen, inclusief privéaanbiedingen met meerdere partijen die aan uw account zijn gekoppeld:

GET https://graph.microsoft.com/rp/product-ingestion/private-offer/query?$version=2023-07-15

De API gebruiken

Met de API voor privéaanbiedingen kunt u privéaanbiedingen maken en beheren die zijn gekoppeld aan producten en abonnementen binnen uw Partnercentrum-account. Hier volgt een samenvatting van het typische aanroepende patroon bij het gebruik van deze API.

Stroomdiagram met privé-aanbiedingen voor meerdere partijen.

Stap 1: De aanvraag indienen

Wanneer u een API-aanroep maakt om een privéaanbieding te maken, verwijderen, intrekken of upgraden, wordt er een nieuwe taak gemaakt om de aangevraagde taak te voltooien. Het API-antwoord bevat een jobId die is gekoppeld aan de taak.

Stap 2: Peiling voor taakstatus

Gebruik de jobId uit het eerste API-antwoord om de taakstatus op te halen. De status van de taak wordt uitgevoerd of voltooid. Zodra de taak is voltooid, wordt het resultaat geslaagd of Mislukt. Om prestatieproblemen te voorkomen, pollt u een taak niet meer dan één keer per minuut.

jobStatus Beschrijving
NotStarted De taak is nog niet gestart; dit maakt deel uit van het antwoord op de eerste aanvraag.
Wordt uitgevoerd De taak wordt nog steeds uitgevoerd.
Voltooid De taak is voltooid. Zie jobResult voor meer informatie.
jobResult Beschrijving
In behandeling De taak is nog niet voltooid.
Geslaagd De taak is voltooid. Deze taak retourneert ook een resource-URI die verwijst naar de privéaanbieding die betrekking heeft op de taak. Gebruik deze resourceURI om de volledige details van een privéaanbieding te verkrijgen.
Mislukt De taak is mislukt. Hiermee worden ook eventuele relevante fouten geretourneerd om de oorzaak van de fout te bepalen.

Zie De status van een bestaande taak opvragen voor meer informatie.

Stap 3: informatie ophalen uit voltooide taken

Een geslaagde taak retourneert een resourceUri die verwijst naar de relevante privéaanbieding. Gebruik deze resource-URI voor meer informatie over de privéaanbieding in de toekomst, zoals de privateofferId.

Een mislukte taak bevat fouten die gedetailleerde informatie geven over waarom de taak is mislukt en hoe u het probleem kunt oplossen.

Zie Details van een bestaande privéaanbieding verkrijgen voor meer informatie.

Hoe ISV en kanaalpartner gezamenlijk de API moeten gebruiken voor privéaanbiedingen met meerdere partijen

Zowel ISV als kanaalpartner kunnen dezelfde API's gebruiken voor het maken en beheren van een bepaalde MPO. Resources in een MPO die van invloed kunnen zijn op de API, zijn echter afhankelijk van of de aanroeper van de API de ISV (originator) of de kanaalpartner (verkoper) van de MPO is. Dezelfde publicatiestroom voor ISV-/kanaalpartner en bedrijfsregels voor partnercentrum worden gespiegeld in de API. Hier volgt een overzicht:

API-bewerking ISV (Originator) Kanaalpartner (verkoper)
Maken
  • Beoogde doelgroep is de verkooppartner (verkoper) wanneer de API-aanroep wordt geplaatst, de eindklant ziet de privéaanbieding pas nadat de kanaalpartner de aanbieding indient
Bewerkbare resources:
  • Effectieve datums
  • Beoogde begunstigde (klant)
  • Kanaalpartner om samen te werken aan de aanbieding, beperkt tot 1 per privéaanbieding
  • Aanvullende ISV-contactpersonen om op de hoogte te worden gesteld van de status van de privéaanbieding
  • Aangepaste voorwaarden voor ISV
  • Producten/abonnementen die zijn opgenomen in de privéaanbieding
  • Contractduur(en) voor elk product/abonnement
  • Inbegrepen hoeveelheden voor elk product (indien van toepassing)
  • Niet-abonnementskenmerken (indien van toepassing)
  • Korting op de groothandelsprijs die beschikbaar is voor de kanaalpartner op de inbegrepen producten/plan
  • ISV-verkoopnotities
  • Beoogde doelgroep is de eindklant wanneer de API-aanroep wordt geplaatst
Bewerkbare resources:
  • Aangepaste voorwaarden voor kanaalpartner
  • Voorbereid door
  • Klantaanpassing (prijsverhogingspercentage) boven op de ISV groothandelsprijs voor elk product/plan dat is opgenomen in de privéaanbieding, dit bepaalt de uiteindelijke eindklantprijs
  • Aanvullende contactpersonen van kanaalpartner die op de hoogte moeten worden gesteld van de status van de privéaanbieding
  • Verkoopnotities van kanaalpartner
Delete
  • Ondersteund voor privéaanbiedingen in conceptstatus
  • Niet ondersteund
Terugtrekken
  • Ondersteund voor privéaanbiedingen die zijn gepubliceerd door de ISV, maar nog niet gepubliceerd door de kanaalpartner of als ze worden ingetrokken door de kanaalpartner
  • Ondersteund voor privéaanbiedingen die zijn gepubliceerd en beschikbaar zijn voor eindgebruikers, maar nog niet geaccepteerd

Gerelateerde inhoud