API-referens för Cloud Partner Portal

  • Artikel

Kommentar

API:erna för Molnpartnerportalen är integrerade med och fortsätter att fungera i Partnercenter. Övergången introducerar små ändringar. Granska ändringarna i CPP-API:er som anges i det här dokumentet för att se till att koden fortsätter att fungera efter övergången till Partnercenter. CPP-API:er bör endast användas för befintliga produkter som redan var integrerade före övergången till Partnercenter. nya produkter ska använda API:er för insändning av Partnercenter.

Rest-API:er för Cloud Partner Portal tillåter programmatisk hämtning och manipulering av arbetsbelastningar, erbjudanden och utgivarprofiler. API:erna använder rollbaserad åtkomstkontroll i Azure (Azure RBAC) för att framtvinga rätt behörigheter vid bearbetningen.

Den här referensen innehåller teknisk information om REST-API:er för Cloud Partner Portal. Nyttolastexemplen i det här dokumentet är endast för referens och kan komma att ändras när nya funktioner läggs till.

Förutsättningar och överväganden

Innan du använder API:erna bör du granska:

  • Artikeln Krav för att lära dig hur du lägger till ett huvudnamn för tjänsten till ditt konto och hämtar en Microsoft Entra-åtkomsttoken för autentisering.
  • De två strategier för samtidighetskontroll som är tillgängliga för att anropa dessa API:er.
  • Andra API-överväganden, till exempel versionshantering och felhantering.

Ändringar i CPP-API:er efter migreringen till Partnercenter

API Ändra beskrivning Påverkan
POST Publish, GoLive, Avbryt För migrerade erbjudanden har svarshuvudet ett annat format men fortsätter att fungera på samma sätt, vilket anger en relativ sökväg för att hämta åtgärdsstatusen. När du skickar någon av motsvarande POST-begäranden för ett erbjudande har platsrubriken ett av två format beroende på erbjudandets migreringsstatus:
  • Icke-invandrade erbjudanden
    /api/operations/{PublisherId}${offerId}$2$preview?api-version=2017-10-31
  • Migrerade erbjudanden
    /api/publishers/{PublisherId}/offers/{offereId}/operations/408a4835-0000-1000-0000-000000000000?api-version=2017-10-31
GET-åtgärd För erbjudandetyper som tidigare stödde fältet "notification-email" i svaret kommer det här fältet att bli inaktuellt och returneras inte längre för migrerade erbjudanden. För migrerade erbjudanden skickar vi inte längre meddelanden till listan över e-postmeddelanden som anges i begärandena. I stället överensstämmer API-tjänsten med e-postaviseringsprocessen i Partnercenter för att skicka e-postmeddelanden. Mer specifikt skickas meddelanden till den e-postadress som anges i avsnittet Säljkontaktinformation i dina kontoinställningar i Partnercenter för att meddela dig om åtgärdens förlopp.

Granska e-postadressen som angetts i avsnittet Säljkontaktinformation i kontoinställningarna i Partnercenter för att se till att rätt e-post har angetts för meddelanden.

Vanliga åtgärder

Den här referensen beskriver API:er för att utföra följande vanliga uppgifter.

Erbjudanden

Operations

Publicera ett program

Andra uppgifter

Felsökning

API-versioner och -uppdateringar

Uppdatering Vad har ändrats?
12-2022 Det offentliga CPP-API:et (version 2017-10-31) har nu uppdaterats för att samla in clientId och clientSecret för Marketo-anslutningsappen samtidigt som kundleads konfigureras. Under leadkonfigurationen behöver du inte ange fältet serverId framöver. Den här uppdateringen av API:et omfattar inga versionsuppdateringar eller icke-bakåtkompatibla ändringar.