Direkthantering API Management REST API

  • Artikel

Azure API Management tillhandahåller ett REST-API för direkthantering för att utföra åtgärder på valda entiteter, till exempel användare, grupper, produkter och prenumerationer. API:et för direkthantering kan kringgå vissa gränser för Det Azure Resource Manager-baserade API:et, till exempel begränsning av begäranden.

Viktigt

I det här avsnittet beskrivs hur du får åtkomst till direkthantering API Management REST API. Det här API:et har en annan autentiseringsmekanism än Azure Resource Manager och använder en annan bas-URL.

Aktivera åtkomst till REST-API:et för direkthantering

Åtkomst till direkthantering API Management REST API måste beviljas innan anrop kan utföras.

  1. Gå till din Azure API Management-instans i Azure Portal.

  2. Välj Hanterings-API i avsnittet Distribution + infrastruktur på menyn till vänster.

    Välj Hanterings-API i Azure Portal

  3. I Aktivera API Management REST API väljer du Ja.

    Viktigt

    Om Aktivera API Management REST API inte har valts misslyckas anrop till REST-API:et för den tjänstinstansen.

    Aktivera API Management API i Azure Portal

Standardmedietyp

Standardmedietypen för begäranden och svar är application/json. Om detta anges har vissa åtgärder stöd för andra innehållstyper. Om ingen ytterligare innehållstyp anges för en viss åtgärd är application/jsonmedietypen .

Autentisering

Varje begäran till API Management REST API måste åtföljas av en Authorization rubrik som innehåller en giltig token för delad åtkomst, enligt följande exempel.

Authorization: SharedAccessSignature uid=53dd860e1b72ff0467030003&ex=2014-08-04T22:03:00.0000000Z&sn=ItH6scUyCazNKHULKA0Yv6T+Skk4bdVmLqcPPPdWoxl2n1+rVbhKlplFrqjkoUFRr0og4wjeDz4yfThC82OjfQ==

Den här åtkomsttoken kan genereras programmatiskt eller från API Management utgivarportalen. Anvisningar om hur du genererar och hämtar åtkomsttoken finns i Skapa en åtkomsttoken manuellt och Skapa en åtkomsttoken programmatiskt.

Grundläggande URL

Bas-URL:en för direkthantering API Management REST API följer följande mall.

https://{servicename}.management.azure-api.net

Den här mallen innehåller följande parameter.

  • {serviceName} är tjänstnamnet som det angavs när tjänsten skapades, till exempel https://contosoapi.management.azure-api.net.

Alla URL:er som returneras av API Management REST API är relativa till den här bas-URL:en, och alla begäranden till REST-API:et måste använda den här bas-URL-mallen.

Frågeparameter för version

Alla åtgärder förväntar sig en api-version frågeparameter med ett värde i formatet YYYY-MM-DD, till exempel 2021-08-01.

Anteckning

Under en förhandsversionsperiod för en API Management REST API -preview läggs till i frågeparametern version, till exempel 2021-04-01-preview.

Om den här frågeparametern inte skickas i frågesträngen för en begäran returnerar servern statuskoden 400 Bad Request. En lista över versioner som stöds finns i API Management REST API-referens.

Nästa steg