Zelfstudie: Een product maken en publiceren

VAN TOEPASSING OP: Alle API Management-lagen

In Azure API Management bevat een product een of meer API's, een gebruiksquotum en de gebruiksvoorwaarden. Nadat een product is gepubliceerd, kunnen ontwikkelaars zich abonneren op het product en de API's van het product gaan gebruiken.

In deze zelfstudie leert u het volgende:

• Een product maken en publiceren
• Een API toevoegen aan het product
• Toegang tot product-API's

Vereisten

• Leer de terminologie van Azure API Management.
• Lees de volgende snelstartgids: Een Azure API Management-exemplaar maken.
• Voltooi tevens de volgende zelfstudie: Uw eerste API importeren en publiceren.

Een product maken en publiceren

Portal

1. Meld u aan bij Azure Portal en ga naar uw API Management-exemplaar.

2. Selecteer Producten>+ Toevoegen in het linkernavigatiedeelvenster.

   

3. Voer in het venster Add product (Product toevoegen) de waarden in die in de volgende tabel worden beschreven om uw product te maken.

   

   Name	Beschrijving
   Display name	De naam zoals u wilt dat deze wordt weergegeven in de ontwikkelaarsportal.
   Beschrijving	Geef informatie op over het product, zoals het doel, de API's waartoe het toegang geeft, en andere details.
   Staat	Selecteer Published (Gepubliceerd) als u het product wilt publiceren. Voordat de API's in een product kunnen worden aangeroepen, moet het product worden gepubliceerd. Nieuwe producten worden standaard niet-gepubliceerd, en zijn alleen zichtbaar voor gebruikers in de groep Beheerders.
   Abonnement is vereist	Selecteer of een gebruiker zich moet abonneren om het product te gebruiken (het product is beveiligd) en een abonnementssleutel moet worden gebruikt om toegang te krijgen tot de API's van het product. Als een abonnement niet is vereist (het product is geopend), is een abonnementssleutel niet vereist voor toegang tot de API's van het product. Zie Toegang tot product-API's verderop in dit artikel.
   Goedkeuring vereist	Selecteer dit als u wilt dat een beheerder abonnementspogingen voor dit product beoordeelt en accepteert of weigert. Als dit niet geselecteerd is, worden abonnementspogingen automatisch goedgekeurd.
   Limiet voor het aantal abonnementen	U kunt desgewenst het aantal gelijktijdige abonnementen beperken.
   Juridische voorwaarden	U kunt ook de gebruiksvoorwaarden voor het product opnemen, die abonnees moeten accepteren om het product te kunnen gebruiken.
   API's	Selecteer een of meer API's. U kunt ook API's toevoegen na het maken van het product. Zie API's toevoegen aan een product verderop in dit artikel voor meer informatie. Als het product is geopend (hiervoor is geen abonnement vereist), kunt u alleen een API toevoegen die niet is gekoppeld aan een ander geopend product.

4. Selecteer Maken om uw nieuwe product te maken.

Let op

Zorg ervoor dat u een product configureert waarvoor geen abonnement is vereist. Deze configuratie is mogelijk te missief en kan de API's van het product kwetsbaarder maken voor bepaalde API-beveiligingsrisico's.

Azure-CLI

Ga als volgt te werk om Azure CLI te gebruiken:

• Gebruik de Bash-omgeving in Azure Cloud Shell. Zie quickstart voor Bash in Azure Cloud Shell voor meer informatie.

  

• Installeer de Azure CLI, indien gewenst, om CLI-referentieopdrachten uit te voeren. Als u in Windows of macOS werkt, kunt u Azure CLI uitvoeren in een Docker-container. Zie De Azure CLI uitvoeren in een Docker-container voor meer informatie.

  • Als u een lokale installatie gebruikt, meldt u zich aan bij Azure CLI met behulp van de opdracht az login. Volg de stappen die worden weergegeven in de terminal, om het verificatieproces te voltooien. Raadpleeg Aanmelden bij Azure CLI voor aanvullende aanmeldingsopties.

  • Installeer de Azure CLI-extensie bij het eerste gebruik, wanneer u hierom wordt gevraagd. Raadpleeg Extensies gebruiken met Azure CLI voor meer informatie over extensies.

  • Voer az version uit om de geïnstalleerde versie en afhankelijke bibliotheken te vinden. Voer az upgrade uit om te upgraden naar de nieuwste versie.

Voer de opdracht az apim product create uit om een product te maken :

az apim product create --resource-group apim-hello-word-resource-group \
    --product-name "Contoso product" --product-id contoso-product \
    --service-name apim-hello-world --subscription-required true \
    --state published --description "This is a test."

U kunt verschillende waarden voor uw product opgeven:

Parameter	Description
--product-name	De naam zoals u wilt dat deze wordt weergegeven in de ontwikkelaarsportal.
--description	Geef informatie op over het product, zoals het doel, de API's waartoe het toegang geeft, en andere details.
--state	Selecteer gepubliceerd als u het product wilt publiceren. Voordat de API's in een product kunnen worden aangeroepen, moet het product worden gepubliceerd. Nieuwe producten worden standaard niet-gepubliceerd, en zijn alleen zichtbaar voor gebruikers in de groep Beheerders.
--subscription-required	Selecteer of een gebruiker is vereist om zich te abonneren op het gebruik van het product (het product is beveiligd) of als er geen abonnement is vereist (het product is geopend). Zie Toegang tot product-API's verderop in dit artikel.
--approval-required	Selecteer dit als u wilt dat een beheerder abonnementspogingen voor dit product beoordeelt en accepteert of weigert. Als dit niet geselecteerd is, worden abonnementspogingen automatisch goedgekeurd.
--subscriptions-limit	U kunt desgewenst het aantal gelijktijdige abonnementen beperken.
--legal-terms	U kunt de gebruiksvoorwaarden voor het product opnemen, die abonnees moeten accepteren om het product te gebruiken.

Let op

Zorg ervoor dat u een product configureert waarvoor geen abonnement is vereist. Deze configuratie is mogelijk te missief en kan de API's van het product kwetsbaarder maken voor bepaalde API-beveiligingsrisico's.

Als u uw huidige producten wilt zien, gebruikt u de opdracht az apim product list :

az apim product list --resource-group apim-hello-word-resource-group \
    --service-name apim-hello-world --output table

U kunt een product verwijderen met behulp van de opdracht az apim product delete :

az apim product delete --product-id contoso-product \
    --resource-group apim-hello-word-resource-group \
    --service-name apim-hello-world --delete-subscriptions true

Meer configuraties toevoegen

Ga door met het configureren van het product nadat u het hebt opgeslagen. Selecteer in uw API Management-exemplaar het product in het venster Products (Producten). Toevoegen of bijwerken:

Item	Beschrijving
Instellingen	Metagegevens en status van product
API's	API's die zijn gekoppeld aan het product
Beleidsregels	Op product-API's toegepast beleid
Toegangsbeheer	Zichtbaarheid van het product voor ontwikkelaars of gasten
Abonnementen	Productabonnees

API's toevoegen aan een product

Producten zijn koppelingen van een of meer API's. U kunt vele API's opnemen en deze beschikbaar stellen voor ontwikkelaars via de ontwikkelaarsportal. Tijdens het maken van het product kunt u een of meer bestaande API's toevoegen. U kunt ook later API's aan het product toevoegen, via de pagina met instellingen van het product of tijdens het maken van een API.

Een API toevoegen aan een bestaand product

Portal

1. Selecteer Products (Producten) in de linkernavigatie van uw API Management-exemplaar.
2. Selecteer een product en selecteer vervolgens API's.
3. Selecteer + API toevoegen.
4. Selecteer een of meer API's en selecteer vervolgens.

Azure-CLI

1. Gebruik de opdracht az apim api list om uw beheerde API's weer te geven:

   az apim api list --resource-group apim-hello-word-resource-group \
       --service-name apim-hello-world --output table
   

2. Als u een API wilt toevoegen aan uw product, voert u de opdracht az apim product API add uit :

   az apim product api add --resource-group apim-hello-word-resource-group \
       --api-id demo-conference-api --product-id contoso-product \
       --service-name apim-hello-world
   

3. Controleer de toevoeging met behulp van de opdracht az apim product api list :

   az apim product api list --resource-group apim-hello-word-resource-group \
       --product-id contoso-product --service-name apim-hello-world --output table
   

U kunt een API uit een product verwijderen met behulp van de opdracht az apim product api delete :

az apim product api delete --resource-group apim-hello-word-resource-group \
    --api-id demo-conference-api --product-id contoso-product \
    --service-name apim-hello-world

Toegang tot product-API's

Nadat u een product hebt gepubliceerd, hebben ontwikkelaars toegang tot de API's. Afhankelijk van hoe het product is geconfigureerd, moeten ze zich mogelijk abonneren op het product voor toegang.

• Beveiligd product : ontwikkelaars moeten zich eerst abonneren op een beveiligd product om toegang te krijgen tot de API's van het product. Wanneer ze zich abonneren, krijgen ze een abonnementssleutel die toegang heeft tot elke API in dat product. Als u het API Management-exemplaar hebt gemaakt, bent u al een beheerder en bent u standaard geabonneerd op elk product. Zie Abonnementen in Azure API Management voor meer informatie.

  Wanneer een client een API-aanvraag doet met een geldige productabonnementscode, verwerkt API Management de aanvraag en staat toegang toe in de context van het product. Beleidsregels en regels voor toegangsbeheer die voor het product zijn geconfigureerd, kunnen worden toegepast.

  Tip

  U kunt het abonnement van een gebruiker op een product maken of bijwerken met aangepaste abonnementssleutels via een REST API of een PowerShell-opdracht.

• Open product : ontwikkelaars hebben toegang tot de API's van een open product zonder abonnementssleutel. U kunt echter andere mechanismen configureren om clienttoegang tot de API's te beveiligen, waaronder OAuth 2.0, clientcertificaten en het beperken van IP-adressen van bellers.

  Notitie

  Open producten worden niet vermeld in de ontwikkelaarsportal voor ontwikkelaars voor meer informatie over of abonneren op. Ze zijn alleen zichtbaar voor de groep Beheer istrators. U moet een ander mechanisme gebruiken om ontwikkelaars te informeren over API's die toegankelijk zijn zonder abonnementssleutel.

  Wanneer een client een API-aanvraag doet zonder een abonnementssleutel:

  • API Management controleert of de API is gekoppeld aan een open product. Een API kan aan maximaal één open product worden gekoppeld.

  • Als het geopende product bestaat, verwerkt het de aanvraag in de context van dat geopende product. Beleidsregels en regels voor toegangsbeheer die zijn geconfigureerd voor het open product, kunnen worden toegepast.

Zie Hoe API Management aanvragen verwerkt met of zonder abonnementssleutels voor meer informatie.

Volgende stappen

In deze zelfstudie heeft u het volgende geleerd:

• Een product maken en publiceren
• Een API toevoegen aan het product
• Toegang tot product-API's

Ga door naar de volgende zelfstudie:

Create blank API and mock API responses (Lege API en mock-API-reacties maken)