Přehled rozhraní API pro odesílání privátních nabídek
Soukromé nabídky umožňují vydavatelům a zákazníkům provádět transakce s jedním nebo více produkty na Azure Marketplace vytvořením časově vázané ceny s přizpůsobenými podmínkami. Rozhraní API pro odesílání privátních nabídek umožňují vydavatelům programově vytvářet a spravovat privátní nabídky pro zákazníky nebo partnery CSP. Toto rozhraní API používá k ověření volání z vaší aplikace nebo služby ID Microsoft Entra.
V Partnerském centru jsou k dispozici tři hlavní typy privátních nabídek a podporované rozhraním API pro odesílání privátních nabídek:
- Soukromá nabídka nezávislých výrobců softwaru pro zákazníky – označuje se také jako soukromá nabídka zákazníka v Partnerském centru. Jedná se o vlastní dohodu mezi isV a konkrétním zákazníkem s přizpůsobenými podmínkami a cenami konkrétního produktu na Azure Marketplace. Přečtěte si další informace o privátní nabídce nezávislých výrobců softwaru pro zákazníky.
- Soukromá nabídka partnera ISV to CSP – v Partnerském centru se také označuje jako soukromá nabídka partnerů CSP. Tento typ privátní nabídky umožňuje poskytovateli softwaru určit časové rozpětí, které vytvoří velkoobchodní cenu pro svého partnera CSP. Přečtěte si další informace o privátní nabídce partnera CSP od nezávislých výrobců softwaru.
- Multiparty private offer (MPO) – vlastní dohoda nakonfigurovaná nezávislou společností isV a upřednostňovaným distribučním partnerem konkrétního zákazníka s přizpůsobenými podmínkami a cenami pro konkrétní produkty na Azure Marketplace. Výrobce softwaru definuje zlevněnou velkoobchodní cenu dostupnou partnerovi, distribuční partner pak může přidat kód nad velkoobchodní cenu, aby přišel na konečnou cenu zákazníka a nabídne zákazníkovi nabídku pro přijetí a nákup. Přijetí a nákup MPO se řídí stejným tokem jako isV k privátním nabídkám zákazníků. Přečtěte si další informace o vícedílné privátní nabídce.
Terminologie
- Původce MPO – MPO je spolupráce mezi isV a distribučním partnerem na stejné vlastní dohodě pro konkrétního zákazníka, strana, která poprvé vytvoří MPO, je určena "původcem" nabídky, obvykle isV produktů zahrnutých v MPO. Existuje pouze jeden původce pro libovolnou mpo.
- Prodejce MPO – distribuční partner, který připravuje nabídku s konečnou cenou zákazníka a prezentuje nabídku zákazníkovi, je prodejcem MPO. V každém mpo může být pouze jeden prodejce.
- Produkt – jedna jednotka představující nabídku na Azure Marketplace Na stránce výpisu je jeden produkt.
- Plán – jedna verze konkrétního produktu. Pro daný produkt může existovat více plánů, které představují různé úrovně cen nebo podmínek.
- Úloha – úloha vytvořená při vytváření požadavku v tomto rozhraní API. Při použití tohoto rozhraní API ke správě privátních nabídek a vícedílné soukromé nabídky se vytvoří úloha pro dokončení požadavku. Po dokončení úlohy můžete získat další informace o relevantní (vícedílné) privátní nabídce.
Podporované scénáře
- Vytvoření privátní nabídky pro zákazníka
- Vytvoření privátní nabídky pro prodejce
- Vytvoření vícedílné privátní nabídky pro zákazníka
- Odstranění privátní nabídky
- Stažení soukromé nabídky
- Dotaz na seznam privátních nabídek s více částmi
- Dotaz na seznam produktů a plánů
Příprava na použití tohoto rozhraní API
Než napíšete kód pro volání rozhraní API privátních nabídek, ujistěte se, že jste dokončili následující požadavky. Stejné požadavky platí pro všechny partnery publikování.
Krok 1: Dokončení požadavků pro používání rozhraní API pro příjem produktů Microsoftu (jednorázově)
Vy nebo vaše organizace musíte mít adresář Microsoft Entra a oprávnění globálního správce. Pokud už používáte Microsoft 365 nebo jiné obchodní služby od Microsoftu, už máte adresář Microsoft Entra. Pokud ne, můžete zdarma vytvořit nové ID Microsoft Entra v Partnerském centru.
Aplikaci Microsoft Entra ID musíte přidružit k účtu Partnerského centra a získat ID tenanta, ID klienta a klíč. Tyto hodnoty potřebujete k získání přístupového tokenu Microsoft Entra, který použijete při volání rozhraní API privátních nabídek.
Krok 2: Získání přístupového tokenu Microsoft Entra (pokaždé)
Před voláním některé z metod v rozhraní API pro odesílání microsoft Storu potřebujete přístupový token Microsoft Entra, který předá autorizační hlavičce každé metody v rozhraní API. Token můžete použít 60 minut, než vyprší jeho platnost. Po vypršení platnosti můžete token aktualizovat, abyste ho mohli dál používat v dalších voláních rozhraní API.
Pokud chcete získat přístupový token, přečtěte si téma Volání služeb pomocí přihlašovacích údajů klienta k odeslání protokolu HTTP POST do koncového https://login.microsoftonline.com/<bodu tenant_id>/oauth2/token . Tady je ukázkový požadavek:
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/
Pro hodnotu tenant_id v identifikátoru POST URI a parametrech client_id a client_secret zadejte ID tenanta, ID klienta a klíč pro vaši aplikaci, kterou jste získali z Partnerského centra v předchozí části. Pro parametr prostředku je nutné zadat https://graph.microsoft.com/.
Vyhledání ID produktů, plánů a privátních nabídek
| ID | Kde je najít |
|---|---|
| client_id | Viz Přidružení aplikace Microsoft Entra k vašemu účtu v Partnerském centru. |
| tenant_id | Viz Přidružení aplikace Microsoft Entra k vašemu účtu v Partnerském centru. |
| tajný klíč klienta | Viz Přidružení aplikace Microsoft Entra k vašemu účtu v Partnerském centru. |
| productId | Viz Načtení produktů v tomto článku. |
| planId | Viz Načtení plánů pro konkrétní produkt v tomto článku. |
| privateofferId | Viz Načtení soukromých nabídek v tomto článku. |
Načtení produktů
Soukromá nabídka je založená na existujícím produktu ve vašem účtu Partnerského centra. Pokud chcete zobrazit seznam produktů přidružených k vašemu účtu Partnerského centra, použijte toto volání rozhraní API:
GET https://graph.microsoft.com/rp/product-ingestion/product?$version=2022-07-01
Odpověď se zobrazí v následujícím ukázkovém formátu:
{
"value": [
{
"$schema": "https://schema.mp.microsoft.com/schema/product/2022-07-01",
"id": "string",
"identity": {
"externalId": "string"
},
"type": "enum",
"alias": "string"
}
],
"@nextLink": "opaque_uri"
}
Načtení plánů pro konkrétní produkt
U produktů, které obsahují více než jeden plán, můžete chtít vytvořit soukromou nabídku na základě jednoho konkrétního plánu. Pokud ano, potřebujete ID daného plánu. Pomocí následujícího volání rozhraní API získejte seznam plánů (například variant nebo skladových položek) produktu:
GET https://graph.microsoft.com/rp/product-ingestion/plan?product=<product-id>&$version=2022-07-01
Odpověď se zobrazí v následujícím ukázkovém formátu:
{
"value": [
{
"$schema": "https://schema.mp.microsoft.com/schema/plan/2022-07-01",
"product": "string",
"id": "string",
"identity": {
"externalId": "string"
},
"alias": "string"
}
]
}
Načtení privátních nabídek
Pokud chcete zobrazit seznam všech privátních nabídek, včetně vícedílných privátních nabídek přidružených k vašemu účtu, použijte následující volání rozhraní API:
GET https://graph.microsoft.com/rp/product-ingestion/private-offer/query?$version=2023-07-15
Jak používat rozhraní API
Rozhraní API privátní nabídky umožňuje vytvářet a spravovat privátní nabídky přidružené k produktům a plánům v rámci vašeho účtu Partnerského centra. Tady je souhrn typického vzorce volání při použití tohoto rozhraní API.
Krok 1: Provedení požadavku
Když provedete volání rozhraní API pro vytvoření, odstranění, odvolání nebo upgrade privátní nabídky, vytvoří se nová úloha pro dokončení požadovaného úkolu. Odpověď rozhraní API obsahuje ID úlohy přidružené k úloze.
Krok 2: Dotazování na stav úlohy
Pomocí id úlohy z počáteční odpovědi rozhraní API se dotazujte, abyste získali stav úlohy. Stav úlohy bude Spuštěno nebo Dokončeno. Po dokončení úlohy bude výsledek úspěšný nebo neúspěšný. Abyste se vyhnuli problémům s výkonem, nevyhledávejte úlohu více než jednou za minutu.
| jobStatus | Popis |
|---|---|
| NotStarted | Práce ještě nezačala; to je součástí odpovědi na počáteční požadavek. |
| Spuštěno | Úloha je stále spuštěná. |
| Dokončeno | Úloha byla dokončena. Další podrobnosti najdete v jobResult. |
| jobResult | Popis |
| Probíhá | Úloha ještě nebyla dokončena. |
| Úspěšný | Úloha byla úspěšně dokončena. Tato úloha také vrátí identifikátor resourceURI, který odkazuje na privátní nabídku související s úlohou. Pomocí tohoto identifikátoru RESOURCEURI získáte úplné podrobnosti privátní nabídky. |
| Neúspěšný | Úloha se nezdařila. Tím se vrátí také všechny relevantní chyby, které vám pomůžou určit příčinu selhání. |
Další informace najdete v tématu Dotazování na stav existující úlohy.
Krok 3: Získání informací z dokončených úloh
Úspěšná úloha vrátí identifikátor resourceURI odkazující na příslušnou privátní nabídku. Pomocí tohoto identifikátoru URI prostředku získáte další podrobnosti o privátní nabídce v budoucnu, například privateofferId.
Neúspěšná úloha obsahuje chyby, které obsahují podrobnosti o tom, proč úloha selhala a jak problém vyřešit.
Další informace naleznete v tématu Získání podrobností o existující privátní nabídce.
Jak by měl partner isV a channel partner společně používat rozhraní API pro vícedílnou soukromou nabídku
K vytvoření a správě daného MPO můžou používat stejná rozhraní API i partner kanálu isV. Prostředky v MPO, které můžou ovlivnit rozhraní API, ale závisí na tom, jestli je volající rozhraní API výrobce softwaru (původcem) nebo distribučním partnerem (prodejcem) MPO. Stejný tok publikování nezávislých výrobců softwaru nebo kanálu a obchodní pravidla, která řídí Partnerské centrum, se zrcadlí v rozhraní API. Tady je přehled:
| Operace rozhraní API | ISV (původce) | Distribuční partner (prodejce) |
|---|---|---|
| Vytvoření |
|
|
| Odstranění |
|
|
| Stáhnout |
|
|