Zagadnienia dotyczące interfejsu API

Obsługa wersji interfejsu API

Uwaga

Interfejsy API portalu Cloud Partner Portal są zintegrowane z usługą i będą nadal działać w Centrum partnerskim. Przejście wprowadza niewielkie zmiany. Przejrzyj zmiany wymienione w dokumentacji interfejsu API portalu Cloud Partner Portal, aby upewnić się, że kod będzie nadal działać po przejściu do Centrum partnerskiego. Interfejsy API CPP powinny być używane tylko dla istniejących produktów, które zostały już zintegrowane przed przejściem do Centrum partnerskiego; nowe produkty powinny używać interfejsów API przesyłania w Centrum partnerskim.

Może istnieć wiele wersji interfejsu API, które są dostępne w tym samym czasie. Klienci muszą wskazać, która wersja ma zostać wywołana przez podanie parametru api-version w ramach ciągu zapytania.

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

Odpowiedź na żądanie z nieznaną lub nieprawidłową wersją interfejsu API to kod HTTP 400. Ten błąd zwraca kolekcję znanych wersji interfejsu API w treści odpowiedzi.

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

Błędy

Interfejs API reaguje na błędy z odpowiednimi kodami stanu HTTP i opcjonalnie dodatkowe informacje w odpowiedzi serializowanej jako JSON. W przypadku wystąpienia błędu, zwłaszcza błędu klasy 400, nie ponawiaj próby żądania przed naprawieniem przyczyny źródłowej. Na przykład w powyższej przykładowej odpowiedzi popraw parametr wersji interfejsu API przed ponownym wysłaniem żądania.

Nagłówek autoryzacji

Dla wszystkich interfejsów API w tym odwołaniu należy przekazać nagłówek autoryzacji wraz z tokenem elementu nośnego uzyskanym z identyfikatora Entra firmy Microsoft. Ten nagłówek jest wymagany do otrzymania prawidłowej odpowiedzi; jeśli nie istnieje, 401 Unauthorized zwracany jest błąd.

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

    Accept: application/json 
    Authorization: Bearer <YOUR_TOKEN>