Důležité informace o rozhraní API

Správa verzí API

Poznámka:

Rozhraní API portálu partnerů cloudu jsou integrovaná a budou pokračovat v práci v Partnerském centru. Přechod zavádí malé změny. Projděte si změny uvedené v referenčních informacích k rozhraní API portálu partnerů cloudu a ujistěte se, že váš kód po přechodu do Partnerského centra bude fungovat i nadále. Rozhraní API CPP by se měla používat pouze pro stávající produkty, které už byly integrované před přechodem do Partnerského centra; nové produkty by měly používat rozhraní API pro odesílání v Partnerském centru.

Může existovat více verzí rozhraní API, které jsou k dispozici současně. Klienti musí určit, jakou verzi chtějí vyvolat, zadáním parametru api-version v rámci řetězce dotazu.

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

Odpověď na požadavek s neznámou nebo neplatnou verzí rozhraní API je kód HTTP 400. Tato chyba vrátí kolekci známých verzí rozhraní API v textu odpovědi.

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

Chyby

Rozhraní API reaguje na chyby s odpovídajícími stavovými kódy HTTP a volitelně dalšími informacemi v odpovědi serializované jako JSON. Pokud se zobrazí chyba, zejména chyba třídy 400, před opravou základní příčiny požadavek opakujte. Například ve výše uvedené ukázkové odpovědi opravte parametr verze rozhraní API před opětovným odesláním požadavku.

Autorizační hlavička

Pro všechna rozhraní API v tomto odkazu musíte předat autorizační hlavičku spolu s nosným tokenem získaným z ID Microsoft Entra. Tato hlavička je nutná k přijetí platné odpovědi; pokud není k dispozici, vrátí se 401 Unauthorized chyba.

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

    Accept: application/json 
    Authorization: Bearer <YOUR_TOKEN>