Oefening: Een API aanroepen met een abonnementssleutel

  • 5 minuten

Een abonnementssleutel is een manier om de toegang tot een API te beperken.

In het voorbeeld van het schoenenbedrijf werkt NorthWind Shoes met een leverancier en willen ze dat deze direct toegang heeft tot de inventaris-API. Partnertoegang moet worden beperkt met behulp van een abonnementssleutel voor alle aanroepen naar de API.

Hier verkrijgt u een abonnementssleutel voor uw API. Vervolgens test u de toegang tot de API met en zonder de abonnementssleutel.

Abonnementssleutels verkrijgen

Partners krijgen hun sleutel als onderdeel van een onboarding-proces. In deze oefening voegt u specifiek een abonnement toe voor de NorthWindShoes-API. Zodra u een sleutel hebt, volgt u een standaardproces voor het gebruik van de sleutel in API-aanroepen.

  1. Selecteer alle resources in het menu van Azure Portal of op de startpagina en selecteer vervolgens uw API Management-exemplaar.

  2. Selecteer Abonnementen in het linkermenuvenster onder API's.

  3. Selecteer + Abonnement en voer de volgende waarden in voor elke instelling. Selecteer vervolgens Maken.

    Instelling Weergegeven als
    Naam NorthWind
    Weergavenaam NorthWind subscription
    Bereik Selecteer API en selecteer vervolgens NorthWindShoes Products in de vervolgkeuzelijst.

  4. Selecteer het contextmenu (...) voor het abonnement Northwind en selecteer vervolgens Sleutels weergeven/verbergen.

  5. Selecteer de knop Klik om te kopiëren voor de PRIMAIRE SLEUTEL.

  6. Bewaar deze sleutel ergens, bijvoorbeeld in Kladblok.

Abonnementssleutel gebruiken in API-aanroep

De volgende stap is om de abonnementssleutel te gebruiken om de toegang van ontwikkelaars tot uw gepubliceerde API te testen.

  1. Voer de volgende opdracht uit in Cloud Shell om toegang te krijgen tot de bewerking Producten in uw API, waarbij u <apim gateway> de naam van uw gateway vervangt.

    curl https://<apim gateway>.azure-api.net/api/Products

    U krijgt een 401, toegang geweigerd vanwege ontbrekend bericht over de abonnementssleutel .

  2. Herhaal nu uw curl-aanvraag, deze keer inclusief uw abonnementssleutel.

  3. Voer de volgende opdracht uit in Cloud Shell, waarbij u de sleutel vervangt <primary key> die u eerder hebt opgeslagen en vervangt door <apim gateway> de naam van uw gateway.

    curl --header "Ocp-Apim-Subscription-Key: <primary key>" https://<apim gateway>.azure-api.net/api/Products

    U hebt nu toegang tot de API en ziet een lijst met producten die naar de console is geretourneerd.