Condividi tramite

Riferimento all'API del portale Cloud Partner

  • Articolo

Nota

Le API del portale Cloud Partner sono integrate con e continueranno a lavorare nel Centro per i partner. La transizione introduce piccole modifiche. Esaminare le modifiche alle API CPP elencate in questo documento per assicurarsi che il codice continui a funzionare dopo la transizione al Centro per i partner. Le API CPP devono essere usate solo per i prodotti esistenti già integrati prima della transizione al Centro per i partner; i nuovi prodotti devono usare le API di invio al Centro per i partner.

Le API REST del portale Cloud Partner consentono il recupero programmatico e la manipolazione di carichi di lavoro, offerte e profili di pubblicazione. Le API usano il controllo degli accessi in base al ruolo di Azure per applicare le autorizzazioni corrette in fase di elaborazione.

Questo riferimento fornisce i dettagli tecnici per le API REST del portale Cloud Partner. Gli esempi di payload in questo documento sono solo di riferimento e sono soggetti a modifiche in seguito all'aggiunta di nuove funzionalità.

Prerequisiti e considerazioni

Prima di usare le API, è opportuno rivedere:

  • L'articolo Prerequisiti per informazioni su come aggiungere un'entità servizio all'account e ottenere un token di accesso Microsoft Entra per l'autenticazione.
  • Le due strategie di controllo della concorrenza disponibili per chiamare queste API.
  • Altre considerazioni sull'API, ad esempio il controllo delle versioni e la gestione degli errori.

Modifiche alle API CPP dopo la migrazione al Centro per i partner

API Descrizione modifica Impatto
Pubblicazione POST, GoLive, annullamento Per le offerte migrate, l'intestazione della risposta ha un formato diverso, ma continua a funzionare nello stesso modo, denotando un percorso relativo per recuperare lo stato dell'operazione. Quando si invia una delle richieste POST corrispondenti per un'offerta, l'intestazione Location ha uno dei due formati a seconda dello stato di migrazione dell'offerta:
  • Offerte non migrate
    /api/operations/{PublisherId}${offerId}$2$preview?api-version=2017-10-31
  • Offerte migrate
    /api/publishers/{PublisherId}/offers/{offereId}/operations/408a4835-0000-1000-0000-000000000000?api-version=2017-10-31
Operazione GET Per i tipi di offerta che in precedenza supportavano il campo "notification-email" nella risposta, questo campo verrà deprecato e non verrà più restituito per le offerte migrate. Per le offerte migrate, non verranno più inviate notifiche all'elenco dei messaggi di posta elettronica specificati nelle richieste. Al contrario, il servizio API è allineato al processo di posta elettronica di notifica nel Centro per i partner per inviare messaggi di posta elettronica. In particolare, le notifiche verranno inviate all'indirizzo di posta elettronica impostato nella sezione Informazioni account nel Centro per i partner, per notificare l'avanzamento dell'operazione.

Esaminare l'indirizzo di posta elettronica impostato nella sezione Informazioni di contatto del venditore delle impostazioni dell'account nel Centro per i partner per assicurarsi che venga fornito il messaggio di posta elettronica corretto per le notifiche.

Attività comuni

Questo riferimento illustra nel dettaglio le API per eseguire le seguenti attività comuni.

Offerte

Operazioni

Pubblicare un'app

Altre attività

Risoluzione dei problemi

Versioni e aggiornamenti delle API

Aggiornamento Cosa è cambiato?
12-2022 L'API pubblica CPP (versione 2017-10-31) viene ora aggiornata per acquisire clientId e clientSecret per il connettore Marketo durante la configurazione dei lead dei clienti. Durante la configurazione dei lead non è necessario specificare il campo serverId in futuro. Questo aggiornamento all'API non comporta aggiornamenti della versione o modifiche di rilievo.