SaaS fulfillment Subscription API-k v2 a Microsoft kereskedelmi piactéren

  • Cikk

Ez a cikk az SaaS fulfillment-előfizetés API-k 2. verzióját ismerteti.

Megvásárolt előfizetés feloldása

A feloldó végpont lehetővé teszi a közzétevő számára, hogy a kereskedelmi piactérről (a megvásárolt, de még nem aktivált jogkivonatként) cserélje le a vásárlásazonosítási jogkivonatotegy állandó megvásárolt SaaS-előfizetés-azonosítóra és annak részleteire.

Amikor a rendszer átirányít egy ügyfelet a partner kezdőlapjának URL-címére, az ügyfélazonosítási jogkivonat lesz átadva tokenparaméterként ebben az URL-hívásban. A partnernek ezt a jogkivonatot kell használnia, és kérnie kell a megoldását. A Resolve API-válasz tartalmazza az SaaS-előfizetés azonosítóját és egyéb részleteket a vásárlás egyedi azonosításához. A kezdőlap URL-hívásához megadott jogkivonat 24 órán át érvényes. Ha a kapott jogkivonat lejárt, javasoljuk, hogy adja meg a következő útmutatást a végfelhasználónak:

"Nem tudtuk azonosítani ezt a vásárlást. Nyissa meg újra ezt az SaaS-előfizetést az Azure Portalon vagy a Microsoft 365 Felügyeleti központ Központban, és válassza ismét a "Fiók konfigurálása" vagy a "Fiók kezelése" lehetőséget.

A Resolve API meghívása az SaaS-előfizetések előfizetési adatait és állapotát adja vissza az összes támogatott állapotban.

Post https://marketplaceapi.microsoft.com/api/saas/subscriptions/resolve?api-version=<ApiVersion>

Lekérdezési paraméterek:

Paraméter Érték
ApiVersion Használja a 2018-08-31-et.

Kérelemfejlécek:

Paraméter Érték
content-type application/json
x-ms-requestid Az ügyfél kérésének nyomon követésére szolgáló egyedi sztringérték, lehetőleg GUID. Ha ez az érték nincs megadva, a rendszer létrehoz egyet, és megadja a válaszfejlécekben.
x-ms-correlationid Az ügyfélen végzett művelet egyedi sztringértéke. Ez a paraméter korrelálja az ügyfélművelet összes eseményét a kiszolgálóoldali eseményekkel. Ha ez az érték nincs megadva, a rendszer létrehoz egyet, és megadja a válaszfejlécekben
authorization Egyedi hozzáférési jogkivonat, amely azonosítja az API-hívást kezdeményező közzétevőt. A formátum az, "Bearer <access_token>" amikor a közzétevő lekéri a jogkivonat értékét a Microsoft Entra alkalmazáson alapuló jogkivonat lekérése című témakörben leírtak szerint.
x-ms-marketplace-token A feloldandó vásárlási azonosító jogkivonat paramétere. A jogkivonat a kezdőlap URL-hívásában lesz átadva, amikor az ügyfél átirányítja az SaaS-partner webhelyére (például: https://contoso.com/signup?token=<token><authorization_token>).

A kódolt jogkivonat értéke a kezdőlap URL-címének része, ezért az API-hívás paraméterként való használata előtt dekódolni kell.

Íme egy példa egy kódolt sztringre az URL-címben: contoso.com/signup?token=ab%2Bcd%2Fefahol a jogkivonat található ab%2Bcd%2Fef. Ugyanez a jogkivonat dekódolva van: Ab+cd/ef

Válaszkódok:

Kód: 200 Egyedi SaaS-előfizetés-azonosítókat ad vissza a x-ms-marketplace-token megadottak alapján.

Példa választörzsre:

{
  "id": "<guid>", // purchased SaaS subscription ID
  "subscriptionName": "Contoso Cloud Solution", // SaaS subscription name
  "offerId": "offer1", // purchased offer ID
  "planId": "silver", // purchased offer's plan ID
  "quantity": 20, // number of purchased seats, might be empty if the plan is not per seat
  "subscription": { // full SaaS subscription details, see Get Subscription APIs response body for full description
    "id": "<guid>",
    "publisherId": "contoso",
    "offerId": "offer1",
    "name": "Contoso Cloud Solution",
    "saasSubscriptionStatus": " PendingFulfillmentStart ",
    "beneficiary": {
      "emailId": "test@test.com",
      "objectId": "<guid>",
      "tenantId": "<guid>",
      "puid": "<ID of the user>"
    },
    "purchaser": {
      "emailId": "test@test.com",
      "objectId": "<guid>",
      "tenantId": "<guid>",
      "puid": "<ID of the user>"
    },
    "planId": "silver",
    "term": {
      "termUnit": "P1M",
      "startDate": "2022-03-07T00:00:00Z", //This field is only available after the saas subscription is active.
      "endDate": "2022-04-06T00:00:00Z" //This field is only available after the saas subscription is active.
    },
      "autoRenew": true/false,
    "isTest": true/false,
    "isFreeTrial": false,
    "allowedCustomerOperations": <CSP purchases>["Read"] <All Others> ["Delete", "Update", "Read"],
      "sandboxType": "None",
      "lastModified": "0001-01-01T00:00:00", //[Deprecated] Do not use.
      "quantity": 5,
    "sessionMode": "None"
  }
}

Kód: 400 Hibás kérés. x-ms-marketplace-token hiányzik, hibás, érvénytelen vagy lejárt.

Kód: 403 Tiltott. Az engedélyezési jogkivonat érvénytelen, lejárt vagy nem lett megadva. A kérés megpróbál hozzáférni egy SaaS-előfizetéshez egy olyan ajánlathoz, amelyet az engedélyezési jogkivonat létrehozásához használttól eltérő Microsoft Entra-alkalmazásazonosítóval tettek közzé.

Ez a hiba gyakran az SaaS-regisztráció helytelen végrehajtásának tünete.

Kód: 500 Belső kiszolgálóhiba. Próbálkozzon újra az API-hívással. Ha a hiba továbbra is fennáll, forduljon a Microsoft ügyfélszolgálatához.

Előfizetés aktiválása

Miután az SaaS-fiók konfigurálva van egy végfelhasználó számára, a közzétevőnek meg kell hívnia az Előfizetés aktiválása API-t a Microsoft oldalán. Az ügyfél számlázása csak akkor történik meg, ha ez az API-hívás sikeres.

Post https://marketplaceapi.microsoft.com/api/saas/subscriptions/<subscriptionId>/activate?api-version=<ApiVersion>

Lekérdezési paraméterek:

Paraméter Érték
ApiVersion Használja a 2018-08-31-et.
subscriptionId A megvásárolt SaaS-előfizetés egyedi azonosítója. Ezt az azonosítót a kereskedelmi piactér engedélyezési jogkivonatának feloldása után kapja meg a Resolve API használatával.

Kérelemfejlécek:

Paraméter Érték
content-type application/json
x-ms-requestid Az ügyfél kérésének nyomon követésére szolgáló egyedi sztringérték, lehetőleg GUID. Ha ez az érték nincs megadva, a rendszer létrehoz egyet, és megadja a válaszfejlécekben.
x-ms-correlationid Az ügyfélen végzett művelet egyedi sztringértéke. Ez a sztring korrelálja az ügyfélművelet összes eseményét a kiszolgálóoldali eseményekkel. Ha ez az érték nincs megadva, a rendszer létrehoz egyet, és megadja a válaszfejlécekben.
authorization Egyedi hozzáférési jogkivonat, amely azonosítja az API-hívást kezdeményező közzétevőt. A formátum az, "Bearer <access_token>" amikor a közzétevő lekéri a jogkivonat értékét a Microsoft Entra alkalmazáson alapuló jogkivonat lekérése című témakörben leírtak szerint.

Válaszkódok:

Kód: 200 Kérés az előfizetés frissítésére és a "Feliratkozás" megjelölésre. A független szoftverszállítók (ISV-k) néhány perc elteltével ellenőrizhetik az előfizetés állapotát (az előfizetés állapotának ellenőrzéséhez olvassa el a Get műveletet). Ezzel végleges választ kaphat arra, hogy az előfizetés sikeresen frissült-e. A feliratkozás sikertelensége automatikusan "Leiratkozás" webhookot küld.

Ehhez a híváshoz nincs választörzs.

Kód: 400 Hibás kérés: az ellenőrzés nem sikerült.

  • Az SaaS-előfizetés felfüggesztett állapotban van.

Kód: 403 Tiltott. Az engedélyezési jogkivonat érvénytelen, lejárt vagy nem lett megadva. A kérés megpróbál hozzáférni egy SaaS-előfizetéshez egy olyan ajánlathoz, amelyet az engedélyezési jogkivonat létrehozásához használttól eltérő Microsoft Entra-alkalmazásazonosítóval tettek közzé.

Ez a hiba gyakran az SaaS-regisztráció helytelen végrehajtásának tünete.

Kód: 404 Nem található. Az SaaS-előfizetés leiratkozott állapotban van.

Kód: 500 Belső kiszolgálóhiba. Próbálkozzon újra az API-hívással. Ha a hiba továbbra is fennáll, forduljon a Microsoft ügyfélszolgálatához.

Az összes előfizetés listájának lekérése

Ez az API lekéri az összes megvásárolt SaaS-előfizetés listáját a közzétevő által a kereskedelmi piactéren közzétett összes ajánlathoz. A rendszer minden lehetséges állapotban visszaadja az SaaS-előfizetéseket. A leiratkozott SaaS-előfizetések is vissza lesznek adva, mert ezek az információk nem törlődnek a Microsoft oldalán.

Az API oldalanként 100 lapszámozott eredményt ad vissza.

Kap https://marketplaceapi.microsoft.com/api/saas/subscriptions?api-version=<ApiVersion>

Lekérdezési paraméterek:

Paraméter Érték
ApiVersion Használja a 2018-08-31-et.
continuationToken Nem kötelező paraméter. Az eredmények első oldalának lekéréséhez hagyja üresen. Használja a paraméterben @nextLink visszaadott értéket a következő lap lekéréséhez.

Kérelemfejlécek:

Paraméter Érték
content-type application/json
x-ms-requestid Az ügyfél kérésének nyomon követésére szolgáló egyedi sztringérték, lehetőleg GUID. Ha ez az érték nincs megadva, a rendszer létrehoz egyet, és megadja a válaszfejlécekben.
x-ms-correlationid Az ügyfélen végzett művelet egyedi sztringértéke. Ez a paraméter korrelálja az ügyfélművelet összes eseményét a kiszolgálóoldali eseményekkel. Ha ez az érték nincs megadva, a rendszer létrehoz egyet, és megadja a válaszfejlécekben.
authorization Egyedi hozzáférési jogkivonat, amely azonosítja az API-hívást kezdeményező közzétevőt. A formátum az, "Bearer <access_token>" amikor a közzétevő lekéri a jogkivonat értékét a Microsoft Entra alkalmazáson alapuló jogkivonat lekérése című témakörben leírtak szerint.

Válaszkódok:

Kód: 200 A közzétevő összes ajánlatához tartozó összes meglévő előfizetés listáját adja vissza a közzétevő engedélyezési jogkivonata alapján.

Példa választörzsre:

{
  "subscriptions": [
    {
      "id": "<guid>", // purchased SaaS subscription ID
      "name": "Contoso Cloud Solution", // SaaS subscription name
      "publisherId": "contoso", // publisher ID
      "offerId": "offer1", // purchased offer ID
      "planId": "silver", // purchased plan ID
      "quantity": 10, // purchased amount of seats, is empty if plan is not per seat
      "beneficiary": { // email address, user ID and tenant ID for which SaaS subscription was purchased.
        "emailId": " test@contoso.com",
        "objectId": "<guid>",
        "tenantId": "<guid>",
        "puid": "<ID of the user>"
      },
      "purchaser": { // email address, user ID and tenant ID that purchased the SaaS subscription. These could be different from beneficiary information for reseller (CSP) purchase
        "emailId": " test@contoso.com",
        "objectId": "<guid>",
        "tenantId": "<guid>",
        "puid": "<ID of the user>"
      },
      "term": { // The period for which the subscription was purchased.
        "startDate": "2022-03-04T00:00:00Z", //format: YYYY-MM-DD. This is the date when the subscription was activated by the ISV and the billing started. This field is only available after the saas subscription is active.
        "endDate": "2022-04-03T00:00:00Z", // This is the last day the subscription is valid. Unless stated otherwise, the automatic renew happens the next day. This field is only available after the saas subscription is active.
        "termUnit": "P1M" // where P1M is monthly and P1Y is yearly. Also reflected in the startDate and endDate values
      },
      "autoRenew": true,
      "allowedCustomerOperations": ["Read", "Update", "Delete"], // Indicates operations allowed on the SaaS subscription for beneficiary. For CSP-initiated purchases, this is always "Read" because the customer cannot update or delete subscription in this flow. Purchaser can perform all operations on the subscription.
      "sessionMode": "None", // not relevant
      "isFreeTrial": true, // true - the customer subscription is currently in free trial, false - the customer subscription is not currently in free trial. (Optional field -– if not returned, the value is false.)
      "isTest": false, // not relevant
      "sandboxType": "None", // not relevant
      "saasSubscriptionStatus": "Subscribed" // Indicates the status of the operation. Can be one of the following: PendingFulfillmentStart, Subscribed, Suspended or Unsubscribed.
    },
    // next SaaS subscription details, might be a different offer
    {
      "id": "<guid1>",
      "name": "Contoso Cloud Solution1",
      "publisherId": "contoso",
      "offerId": "offer2",
      "planId": "gold",
      "quantity": "",
      "beneficiary": {
        "emailId": " test@contoso.com",
        "objectId": "<guid>",
        "tenantId": "<guid>",
        "puid": "<ID of the user>"
      },
      "purchaser": {
        "emailId": "purchase@csp.com ",
        "objectId": "<guid>",
        "tenantId": "<guid>",
        "puid": "<ID of the user>"
      },
      "term": {
        "startDate": "2019-05-31", /This field is only available after the saas subscription is active.
        "endDate": "2020-04-30",  //This field is only available after the saas subscription is active.
        "termUnit": "P1Y"
      },
      "autoRenew": false,
      "allowedCustomerOperations": ["Read"],
      "sessionMode": "None",
      "isFreeTrial": false,
      "isTest": false,
      "sandboxType": "None",
      "saasSubscriptionStatus": "Suspended"
    }
  ],
  "@nextLink": "https:// https://marketplaceapi.microsoft.com/api/saas/subscriptions/?continuationToken=%5b%7b%22token%22%3a%22%2bRID%3a%7eYeUDAIahsn22AAAAAAAAAA%3d%3d%23RT%3a1%23TRC%3a2%23ISV%3a1%23FPC%3aAgEAAAAQALEAwP8zQP9%2fFwD%2b%2f2FC%2fwc%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%2205C1C9CD673398%22%7d%7d%5d&api-version=2018-08-31" // url that contains continuation token to retrieve next page of the SaaS subscriptions list, if empty or absent, this is the last page. ISV can use this url as is to retrieve the next page or extract the value of continuation token from this url.
}

Ha nem található megvásárolt SaaS-előfizetés a közzétevőhöz, a rendszer üres választörzset ad vissza.

Kód: 403 Tiltott. Az engedélyezési jogkivonat nem érhető el, érvénytelen vagy lejárt.

Ez a hiba gyakran az SaaS-regisztráció helytelen végrehajtásának tünete.

Kód: 500 Belső kiszolgálóhiba. Próbálkozzon újra az API-hívással. Ha a hiba továbbra is fennáll, forduljon a Microsoft ügyfélszolgálatához.

Előfizetés beolvasása

Ez az API lekéri a megadott megvásárolt SaaS-előfizetést egy SaaS-ajánlathoz, amelyet a közzétevő közzétesz a kereskedelmi piactéren. Ezzel a hívással egy adott SaaS-előfizetés összes elérhető információját lekérheti az azonosítója alapján, nem pedig az összes előfizetés listájának lekéréséhez használt API meghívásával.

Kap https://marketplaceapi.microsoft.com/api/saas/subscriptions/<subscriptionId>?api-version=<ApiVersion>

Lekérdezési paraméterek:

Paraméter Érték
ApiVersion Használja a 2018-08-31-et.
subscriptionId A megvásárolt SaaS-előfizetés egyedi azonosítója. Ezt az azonosítót a kereskedelmi piactér engedélyezési jogkivonatának feloldása után kapja meg a Resolve API használatával.

Kérelemfejlécek:

Paraméter Érték
content-type application/json
x-ms-requestid Az ügyfél kérésének nyomon követésére szolgáló egyedi sztringérték, lehetőleg GUID. Ha ez az érték nincs megadva, a rendszer létrehoz egyet, és megadja a válaszfejlécekben.
x-ms-correlationid Az ügyfélen végzett művelet egyedi sztringértéke. Ez a paraméter korrelálja az ügyfélművelet összes eseményét a kiszolgálóoldali eseményekkel. Ha ez az érték nincs megadva, a rendszer létrehoz egyet, és megadja a válaszfejlécekben.
authorization Egyedi hozzáférési jogkivonat, amely azonosítja az API-hívást kezdeményező közzétevőt. A formátum az, "Bearer <access_token>" amikor a közzétevő lekéri a jogkivonat értékét a Microsoft Entra alkalmazáson alapuló jogkivonat lekérése című témakörben leírtak szerint.

Válaszkódok:

Kód: 200 Egy SaaS-előfizetés adatait adja vissza a subscriptionId megadottak alapján.

Példa választörzsre:

{
  "id": "<guid>", // purchased SaaS subscription ID
  "name": "Contoso Cloud Solution", // SaaS subscription name
  "publisherId": "contoso", // publisher ID
  "offerId": "offer1", // purchased offer ID
  "planId": "silver", // purchased plan ID
  "quantity": 10, // purchased amount of seats is empty if plan is not per seat
  "beneficiary": { // email address, user ID and tenant ID for which SaaS subscription is purchased.
    "emailId": "test@contoso.com",
    "objectId": "<guid>",
    "tenantId": "<guid>",
    "puid": "<ID of the user>"
  },
  "purchaser": { // email address ,user ID and tenant ID that purchased the SaaS subscription. These could be different from beneficiary information for reseller (CSP) scenario
    "emailId": "test@test.com",
    "objectId": "<guid>",
    "tenantId": "<guid>",
    "puid": "<ID of the user>"
  },
  "allowedCustomerOperations": ["Read", "Update", "Delete"], // Indicates operations allowed on the SaaS subscription for beneficiary. For CSP-initiated purchases, this is always "Read" because the customer cannot update or delete subscription in this flow. Purchaser can perform all operations on the subscription.
  "sessionMode": "None", // not relevant
  "isFreeTrial": false, // true - the customer subscription is currently in free trial, false - the customer subscription is not currently in free trial. Optional field – if not returned the value is false.
  "autoRenew": true,
  "isTest": false, // not relevant
  "sandboxType": "None", // not relevant
  "created": "2022-03-01T22:59:45.5468572Z",
     "lastModified": "0001-01-01T00:00:00", //[Deprecated] Do not use.
  "saasSubscriptionStatus": " Subscribed ", // Indicates the status of the operation: PendingFulfillmentStart, Subscribed, Suspended or Unsubscribed.
  "term": { // the period for which the subscription was purchased
    "startDate": "2022-03-04T00:00:00Z", //format: YYYY-MM-DD. This is the date when the subscription was activated by the ISV and the billing started. This field is only available after the saas subscription is active.
    "endDate": "2022-04-03T00:00:00Z", // This is the last day the subscription is valid. Unless stated otherwise, the automatic renew happens the next day. This field is only available after the saas subscription is active.
    "termUnit": "P1M" //where P1M is monthly and P1Y is yearly. Also reflected in the startDate and endDate values.
  }
}

Kód: 403 Tiltott. Az engedélyezési jogkivonat érvénytelen, lejárt vagy nem lett megadva. A kérés egy SaaS-előfizetéshez próbál hozzáférni egy olyan ajánlathoz, amely az engedélyezési jogkivonat létrehozásához használttól eltérő Microsoft Entra-alkalmazásazonosítóval van közzétéve.

Ez a hiba gyakran az SaaS-regisztráció helytelen végrehajtásának tünete.

Kód: 404 Nem található. A megadott subscriptionId SaaS-előfizetés nem található.

Kód: 500 Belső kiszolgálóhiba. Próbálkozzon újra az API-hívással. Ha a hiba továbbra is fennáll, forduljon a Microsoft ügyfélszolgálatához.

Elérhető csomagok listázása

Ez az API lekéri az ajánlat adott vásárlása által subscriptionId azonosított SaaS-ajánlat összes csomagját. Ezzel a hívással lekérheti az összes olyan privát és nyilvános csomag listáját, amelyet egy SaaS-előfizetés kedvezményezettje frissíthet az előfizetéshez. A visszaadott csomagok a már megvásárolt csomaggal megegyező földrajzi helyen érhetők el.

Ez a hívás az ügyfél számára elérhető csomagok listáját adja vissza a már megvásárolt csomagon kívül. A lista a közzétevő webhelyén egy végfelhasználó számára is bemutatható. A végfelhasználó a visszaadott listában szereplő csomagok bármelyikére módosíthatja az előfizetési csomagot. A tervnek a listában nem szereplő tervre történő módosítása nem működik.

Ez az API lekéri a társított aktív privát ajánlat azonosítóját is (ha planId-szűrővel hívja meg az API-t). Az API planId-szűrővel való meghívása a sourceOffers csomópont válasz törzsében lévő aktív privát ajánlatazonosító GUID-ket jeleníti meg. A szűrőparamban átadott planId azonosítónak meg kell egyeznie az ügyfél által vásárolt planId azonosítóval.

Kap https://marketplaceapi.microsoft.com/api/saas/subscriptions/<subscriptionId>/listAvailablePlans?api-version=<ApiVersion>&planId=<planId>

Lekérdezési paraméterek:

Paraméter Érték
ApiVersion Használja a 2018-08-31-et.
subscriptionId A megvásárolt SaaS-előfizetés egyedi azonosítója. Ezt az azonosítót a kereskedelmi piactér engedélyezési jogkivonatának feloldása után kapja meg a Resolve API használatával.
planId (Optional) Egy beolvasni kívánt terv tervazonosítója. Ez nem kötelező, és ha figyelmen kívül hagyja, az összes csomagot visszaadja.

Kérelemfejlécek:

Paraméter Érték
content-type application/json
x-ms-requestid Az ügyfél kérésének nyomon követésére szolgáló egyedi sztringérték, lehetőleg GUID. Ha ez az érték nincs megadva, a rendszer létrehoz egyet, és megadja a válaszfejlécekben.
x-ms-correlationid Az ügyfélen végzett művelet egyedi sztringértéke. Ez a paraméter korrelálja az ügyfélművelet összes eseményét a kiszolgálóoldali eseményekkel. Ha ez az érték nincs megadva, a rendszer létrehoz egyet, és megadja a válaszfejlécekben.
authorization Egyedi hozzáférési jogkivonat, amely azonosítja az API-hívást kezdeményező közzétevőt. A formátum az, "Bearer <access_token>" amikor a közzétevő lekéri a jogkivonat értékét a Microsoft Entra alkalmazáson alapuló jogkivonat lekérése című témakörben leírtak szerint.

Válaszkódok:

Kód: 200 Egy meglévő SaaS-előfizetés összes elérhető csomagjának listáját adja vissza, beleértve a már megvásárolt csomagot is.

Az érvénytelen (nem kötelező) planId megadása üres tervlistát ad vissza.

Példa választörzsre:

{
  "plans": [
    {
      "planId": "Platinum001",
      "displayName": "plan display name",
      "isPrivate": true, //returns true for private plans and customized plans created within a private offer.
      "description": "plan description",
      "minQuantity": 5,
      "maxQuantity": 100,
      "hasFreeTrials": false,
      "isPricePerSeat": true,
      "isStopSell": false,
      "market": "US",
      "planComponents": {
        "recurrentBillingTerms": [
          {
            "currency": "USD",
            "price": 1,
            "termUnit": "P1M",
            "termDescription": "term description",
            "meteredQuantityIncluded": [
              {
                "dimensionId": "Dimension001",
                "units": "Unit001"
              }
            ]
          }
        ],
        "meteringDimensions": [
          {
            "id": "MeteringDimension001",
            "currency": "USD",
            "pricePerUnit": 1,
            "unitOfMeasure": "unitOfMeasure001",
            "displayName": "unit of measure display name"
          }
        ]
      },
      "sourceOffers": [ //sourceOffers is returned when planId is passed as filter parameter (note that this is the plan that customer has purchased).
        {
          "externalId": "<guid>" //private offer id, returned when purchase is made through private offer.
        }
      ]
    }
  ]
}

Kód: 404 Nem található. subscriptionId nem található.

Kód: 403 Tiltott. Az engedélyezési jogkivonat érvénytelen, lejárt vagy nem lett megadva. Lehetséges, hogy a kérés egy SaaS-előfizetéshez próbál hozzáférni egy olyan ajánlathoz, amely leiratkozott vagy közzé van téve egy másik Microsoft Entra-alkalmazásazonosítóval az engedélyezési jogkivonat létrehozásához használttól.

Ez a hiba gyakran az SaaS-regisztráció helytelen végrehajtásának tünete.

Kód: 500 Belső kiszolgálóhiba. Próbálkozzon újra az API-hívással. Ha a hiba továbbra is fennáll, forduljon a Microsoft ügyfélszolgálatához.

A csomag módosítása az előfizetésen

Ezzel az API-val frissítheti az SaaS-előfizetéshez vásárolt meglévő csomagot egy új (nyilvános vagy privát) csomagra. A közzétevőnek meg kell hívnia ezt az API-t, ha a kereskedelmi piactéren vásárolt SaaS-előfizetésre vonatkozó terv módosul a közzétevő oldalán.

Ez az API csak aktív előfizetésekhez hívható meg. Bármely terv módosítható bármely más meglévő (nyilvános vagy privát) tervre, de önmagára nem. Privát csomagok esetén az ügyfél bérlőjét a terv célközönségének részeként kell definiálni a Partnerközpontban.

Javítás https://marketplaceapi.microsoft.com/api/saas/subscriptions/<subscriptionId>?api-version=<ApiVersion>

Lekérdezési paraméterek:

Paraméter Érték
ApiVersion Használja a 2018-08-31-et.
subscriptionId A megvásárolt SaaS-előfizetés egyedi azonosítója. Ezt az azonosítót a kereskedelmi piactér engedélyezési jogkivonatának feloldása után kapja meg a Resolve API használatával.

Kérelemfejlécek:

Paraméter Érték
content-type application/json
x-ms-requestid Az ügyfél kérésének nyomon követésére szolgáló egyedi sztringérték, lehetőleg GUID. Ha ez az érték nincs megadva, a rendszer létrehoz egyet, és megadja a válaszfejlécekben.
x-ms-correlationid Az ügyfélen végzett művelet egyedi sztringértéke. Ez a paraméter korrelálja az ügyfélművelet összes eseményét a kiszolgálóoldali eseményekkel. Ha ez az érték nincs megadva, a rendszer létrehoz egyet, és megadja a válaszfejlécekben.
authorization Egyedi hozzáférési jogkivonat, amely azonosítja az API-hívást kezdeményező közzétevőt. A formátum az, "Bearer <access_token>" amikor a közzétevő lekéri a jogkivonat értékét a Microsoft Entra alkalmazáson alapuló jogkivonat lekérése című témakörben leírtak szerint.

Példa a hasznos adatok kérésére:

{
  "planId": "gold" // the ID of the new plan to be purchased
}

Válaszkódok:

Kód: 202 A terv módosítására irányuló kérelmet aszinkron módon fogadták el és kezelték. A partner várhatóan lekérdezi a művelet helyének URL-címét a változásterv-kérelem sikerességének vagy sikertelenségének megállapításához. A lekérdezést néhány másodpercenként kell elvégezni, amíg a művelet végleges állapota sikertelen, sikeres vagy ütközés lesz. A végső művelet állapotát gyorsan vissza kell adni, de bizonyos esetekben több percig is eltarthat.

A partner webhook-értesítést is kap, ha a művelet sikeresen befejeződik a kereskedelmi piactér oldalán. Csak akkor módosítsa a tervet a közzétevő oldalán.

Válaszfejlécek:

Paraméter Érték
Operation-Location A művelet állapotának lekéréséhez szükséges URL-cím. Például: https://marketplaceapi.microsoft.com/api/saas/subscriptions/<subscriptionId>/operations/<operationId>?api-version=2018-08-31

Kód: 400 Hibás kérés: érvényesítési hibák.

  • Az új csomag nem létezik, vagy nem érhető el ehhez az adott SaaS-előfizetéshez.
  • Az új terv megegyezik az aktuális tervével.
  • Az SaaS-előfizetés állapota nincs előfizetve.
  • Az SaaS-előfizetés frissítési művelete nem szerepel a fájlban allowedCustomerOperations.

Kód: 403 Tiltott. Az engedélyezési jogkivonat érvénytelen, lejárt vagy nem lett megadva. A kérés egy SaaS-előfizetéshez próbál hozzáférni egy olyan ajánlathoz, amely az engedélyezési jogkivonat létrehozásához használttól eltérő Microsoft Entra-alkalmazásazonosítóval van közzétéve.

Ez a hiba gyakran az SaaS-regisztráció helytelen végrehajtásának tünete.

Kód: 404 Nem található. Az SaaS-előfizetés subscriptionId nem található.

Kód: 500 Belső kiszolgálóhiba. Próbálkozzon újra az API-hívással. Ha a hiba továbbra is fennáll, forduljon a Microsoft ügyfélszolgálatához.

Feljegyzés

A terv vagy a férőhelyek mennyisége egyszerre módosítható, nem mindkettő.

Ez az API csak akkor hívható meg, ha explicit jóváhagyást kapott a módosításhoz a végfelhasználótól.

A helyek mennyiségének módosítása az SaaS-előfizetésben

Ezzel az API-val frissítheti (növelheti vagy csökkentheti) az SaaS-előfizetéshez vásárolt helyek mennyiségét. A közzétevőnek meg kell hívnia ezt az API-t, ha a kereskedelmi piactéren létrehozott SaaS-előfizetés kiadói oldaláról megváltozik a helyek száma.

Az ülések mennyisége nem lehet nagyobb, mint az aktuális tervben engedélyezett mennyiség. Ebben az esetben a kiadónak módosítania kell a tervet a helyek mennyiségének módosítása előtt.

Javítás https://marketplaceapi.microsoft.com/api/saas/subscriptions/<subscriptionId>?api-version=<ApiVersion>

Lekérdezési paraméterek:

Paraméter Érték
ApiVersion Használja a 2018-08-31-et.
subscriptionId A megvásárolt SaaS-előfizetés egyedi azonosítója. Ezt az azonosítót a kereskedelmi piactér engedélyezési jogkivonatának feloldása után kapja meg a Resolve API használatával.

Kérelemfejlécek:

Paraméter Érték
content-type application/json
x-ms-requestid Az ügyfél kérésének nyomon követésére szolgáló egyedi sztringérték, lehetőleg GUID. Ha ez az érték nincs megadva, a rendszer létrehoz egyet, és megadja a válaszfejlécekben.
x-ms-correlationid Az ügyfélen végzett művelet egyedi sztringértéke. Ez a paraméter korrelálja az ügyfélművelet összes eseményét a kiszolgálóoldali eseményekkel. Ha ez az érték nincs megadva, a rendszer létrehoz egyet, és megadja a válaszfejlécekben.
authorization Egyedi hozzáférési jogkivonat, amely azonosítja az API-hívást kezdeményező közzétevőt. A formátum az, "Bearer <access_token>" amikor a közzétevő lekéri a jogkivonat értékét a Microsoft Entra alkalmazáson alapuló jogkivonat lekérése című témakörben leírtak szerint.

Példa a hasznos adatok kérésére:

{
  "quantity": 5 // the new amount of seats to be purchased
}

Válaszkódok:

Kód: 202 A mennyiség módosítására irányuló kérelmet aszinkron módon fogadták el és kezelték. A partner várhatóan lekérdezi a művelet helyének URL-címét , hogy megállapítsa a változásmennyiség-kérelem sikerességét vagy sikertelenségét. A lekérdezést néhány másodpercenként kell elvégezni, amíg a művelet végleges állapota sikertelen, sikeres vagy ütközés lesz. A végső művelet állapotát gyorsan vissza kell adni, de bizonyos esetekben több percig is eltarthat.

A partner webhook-értesítést is kap, ha a művelet sikeresen befejeződik a kereskedelmi piactér oldalán. Csak akkor módosítsa a mennyiséget a közzétevő oldalán.

Válaszfejlécek:

Paraméter Érték
Operation-Location Hivatkozás egy erőforrásra a művelet állapotának lekéréséhez. Például: https://marketplaceapi.microsoft.com/api/saas/subscriptions/<subscriptionId>/operations/<operationId>?api-version=2018-08-31.

Kód: 400 Hibás kérés: érvényesítési hibák.

  • Az új mennyiség nagyobb vagy alacsonyabb, mint az aktuális terv korlátja.
  • Hiányzik az új mennyiség.
  • Az új mennyiség megegyezik az aktuális mennyiségével.
  • Az SaaS-előfizetés állapota nincs előfizetve.
  • Az SaaS-előfizetés frissítési művelete nem szerepel a fájlban allowedCustomerOperations.

Kód: 403 Tiltott. Az engedélyezési jogkivonat érvénytelen, lejárt vagy nem lett megadva. A kérés olyan előfizetést próbál elérni, amely nem az aktuális közzétevőhöz tartozik.

Ez a hiba gyakran az SaaS-regisztráció helytelen végrehajtásának tünete.

Kód: 404 Nem található. Az SaaS-előfizetés subscriptionId nem található.

Kód: 500 Belső kiszolgálóhiba. Próbálkozzon újra az API-hívással. Ha a hiba továbbra is fennáll, forduljon a Microsoft ügyfélszolgálatához.

Feljegyzés

Egyszerre csak egy terv vagy mennyiség módosítható, mindkettőt nem.

Ez az API csak akkor hívható meg, ha a végfelhasználó kifejezett jóváhagyást kapott a módosításhoz.

Előfizetés lemondása

Ezzel az API-val leiratkozhat egy adott SaaS-előfizetésről. A közzétevőnek nem kell ezt az API-t használnia, és javasoljuk, hogy az ügyfeleket a kereskedelmi piactérre irányítsuk, hogy megszakítsa az SaaS-előfizetéseket.

Ha a közzétevő úgy dönt, hogy végrehajtja a közzétevő oldalán a kereskedelmi piactéren vásárolt SaaS-előfizetés lemondását, ezt az API-t kell meghívnia. A hívás befejezése után az előfizetés állapota leiratkozik a Microsoft oldalán.

Az ügyfélnek nem kell fizetnie, ha egy előfizetést a vásárlástól számított 72 órán belül lemondanak.

Az ügyfél számlázása akkor történik meg, ha az előfizetést az előző türelmi időszak után lemondják. Az ügyfél a lemondás után azonnal elveszíti az SaaS-előfizetéshez való hozzáférést a Microsoft oldalán.

Töröl https://marketplaceapi.microsoft.com/api/saas/subscriptions/<subscriptionId>?api-version=<ApiVersion>

Lekérdezési paraméterek:

Paraméter Érték
ApiVersion Használja a 2018-08-31-et.
subscriptionId A megvásárolt SaaS-előfizetés egyedi azonosítója. Ezt az azonosítót a kereskedelmi piactér engedélyezési jogkivonatának feloldása után kapja meg a Resolve API használatával.

Kérelemfejlécek:

Paraméter Érték
content-type application/json
x-ms-requestid Az ügyfél kérésének nyomon követésére szolgáló egyedi sztringérték, lehetőleg GUID. Ha ez az érték nincs megadva, a rendszer létrehoz egyet, és megadja a válaszfejlécekben.
x-ms-correlationid Az ügyfélen végzett művelet egyedi sztringértéke. Ez a paraméter korrelálja az ügyfélművelet összes eseményét a kiszolgálóoldali eseményekkel. Ha ez az érték nincs megadva, a rendszer létrehoz egyet, és megadja a válaszfejlécekben.
authorization Egyedi hozzáférési jogkivonat, amely azonosítja az API-hívást kezdeményező közzétevőt. A formátum az, "Bearer <access_token>" amikor a közzétevő lekéri a jogkivonat értékét a Microsoft Entra alkalmazáson alapuló jogkivonat lekérése című témakörben leírtak szerint.

Válaszkódok:

Kód: 202 A leiratkozási kérelmet aszinkron módon fogadták el és kezelték. A partner várhatóan lekérdezi a művelet helyének URL-címét a kérés sikerességének vagy sikertelenségének megállapításához. A lekérdezést néhány másodpercenként kell elvégezni, amíg a művelet végleges állapota sikertelen, sikeres vagy ütközés lesz. A végső művelet állapotát gyorsan vissza kell adni, de bizonyos esetekben több percig is eltarthat.

A partner webhook-értesítést is kap, ha a művelet sikeresen befejeződött a kereskedelmi piactér oldalán. Csak akkor mondja le a közzétevő az előfizetést a közzétevő oldalán.

Kód: 200 Az előfizetés már leiratkozott állapotban van.

Válaszfejlécek:

Paraméter Érték
Operation-Location Hivatkozás egy erőforrásra a művelet állapotának lekéréséhez. Például: https://marketplaceapi.microsoft.com/api/saas/subscriptions/<subscriptionId>/operations/<operationId>?api-version=2018-08-31.

Kód: 400 Hibás kérés. A törlés nem szerepel az SaaS-előfizetés listájában allowedCustomerOperations .

Kód: 403 Tiltott. Az engedélyezési jogkivonat érvénytelen, lejárt vagy nem érhető el.

Ez a hiba gyakran az SaaS-regisztráció helytelen végrehajtásának tünete.

Kód: 404 Nem található. Az SaaS-előfizetés subscriptionId nem található.

Kód: 409

A törlés nem hajtható végre, mert az előfizetés zárolva van a függőben lévő művelet(ek) miatt.

Kód: 500 Belső kiszolgálóhiba. Próbálkozzon újra az API-hívással. Ha a hiba továbbra is fennáll, forduljon a Microsoft ügyfélszolgálatához.

Következő lépések