Condividi tramite

Considerazioni sulle API

  • Articolo

Controllo delle versioni API

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 elencate in Informazioni di riferimento sull'API del portale Cloud Partner 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.

Possono essere disponibili più versioni dell'API contemporaneamente. I client devono indicare di quale versione intendono richiamare l'uso specificando il parametro api-version nell'ambito della stringa di query.

GET https://cloudpartner.azure.com/api/offerTypes?api-version=2017-10-31

La risposta a una richiesta con una versione API sconosciuta o non valida è un codice HTTP 400. Questo errore restituisce la raccolta delle versioni di API note nel corpo della risposta.

    {
        "error": { 
            "code":"InvalidAPIVersion",
            "message":"Invalid api version. Allowed values are [2016-08-01-preview]"
        }
    }

Errori

L'API risponde agli errori con i codici di stato HTTP corrispondenti ed eventualmente altre informazioni nella risposta serializzata in formato JSON. Quando si riceve un errore, in particolare un errore di classe 400, non ripetere la richiesta prima di aver corretto la causa sottostante. Ad esempio, nella risposta di esempio precedente, correggere il parametro della versione API prima di inviare nuovamente la richiesta.

Authorization header (Intestazione dell'autorizzazione)

Per tutte le API in questo riferimento, è necessario passare l'intestazione dell'autorizzazione insieme al token di connessione ottenuto dall'ID Microsoft Entra. Questa intestazione è obbligatoria per ricevere una risposta valida; se non è presente, viene restituito un errore 401 Unauthorized.

  GET https://cloudpartner.azure.com/api/offerTypes?api-version=2016-08-01-preview

    Accept: application/json 
    Authorization: Bearer <YOUR_TOKEN>