API-överväganden

API-versionshantering

Kommentar

API:erna för Molnpartnerportalen är integrerade med och fortsätter att fungera i Partnercenter. Övergången introducerar små ändringar. Granska ändringarna som anges i API-referensen för Cloud Partner Portal 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.

Det kan finnas flera versioner av API:et som är tillgängliga samtidigt. Klienter måste ange vilken version de vill anropa genom att ange parametern api-version som en del av frågesträngen.

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

Svaret på en begäran med en okänd eller ogiltig API-version är en HTTP-kod 400. Det här felet returnerar samlingen av kända API-versioner i svarstexten.

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

Fel

API:et svarar på fel med motsvarande HTTP-statuskoder och eventuellt ytterligare information i svaret serialiserat som JSON. När du får ett fel, särskilt ett 400-klassfel, försök inte igen innan du åtgärdar den underliggande orsaken. I exempelsvaret ovan kan du till exempel åtgärda API-versionsparametern innan du skickar begäran igen.

Auktoriseringshuvud

För alla API:er i den här referensen måste du skicka auktoriseringshuvudet tillsammans med ägartoken som hämtats från Microsoft Entra-ID: t. Det här huvudet krävs för att få ett giltigt svar. Om det inte finns returneras ett 401 Unauthorized fel.

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

    Accept: application/json 
    Authorization: Bearer <YOUR_TOKEN>