Overwegingen voor API's

  • Artikel

API-versiebeheer

Notitie

De Cloud Partner Portal-API's zijn geïntegreerd met en blijven werken in partnercentrum. De overgang introduceert kleine wijzigingen. Bekijk de wijzigingen die worden vermeld in Naslaginformatie over de Cloud Partner Portal-API om ervoor te zorgen dat uw code blijft werken na de overgang naar partnercentrum. CPP-API's mogen alleen worden gebruikt voor bestaande producten die al zijn geïntegreerd vóór de overgang naar partnercentrum; nieuwe producten moeten gebruikmaken van de Api's voor verzending van partnercentrum.

Er kunnen meerdere versies van de API tegelijk beschikbaar zijn. Clients moeten aangeven welke versie ze willen gebruiken door de api-version parameter op te geven als onderdeel van de queryreeks.

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

Het antwoord op een aanvraag met een onbekende of ongeldige API-versie is een HTTP-code 400. Deze fout retourneert de verzameling bekende API-versies in de antwoordtekst.

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

Fouten

De API reageert op fouten met de bijbehorende HTTP-statuscodes en optioneel aanvullende informatie in het antwoord geserialiseerd als JSON. Wanneer u een fout ontvangt, met name een 400-klasse-fout, moet u de aanvraag niet opnieuw proberen voordat u de onderliggende oorzaak hebt opgelost. Corrigeer bijvoorbeeld in het bovenstaande voorbeeldantwoord de parameter API-versie voordat u de aanvraag opnieuw verzendt.

Autorisatieheader

Voor alle API's in deze verwijzing moet u de autorisatieheader doorgeven, samen met het bearer-token dat is verkregen van Azure Active Directory (Azure AD). Deze header is vereist om een geldig antwoord te ontvangen; als deze niet aanwezig is, wordt er een 401 Unauthorized fout geretourneerd.

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

    Accept: application/json 
    Authorization: Bearer <YOUR_TOKEN>