Zelfstudie: Een product maken en publiceren

Artikel
09/28/2021
5 minuten om te lezen

In Azure API Management bevat een product een of meer API's, evenals een gebruiksquotum en de gebruiksvoorwaarden. Zodra 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

API Management-producten in portal

Vereisten

Informatie over de terminologie van Azure API Management.
Voltooi de volgende snelstartgids: Een Azure API Management-exemplaar maken.
Voltooi ook de volgende zelfstudie: Uw eerste API importeren en publiceren.

Meld u aan bij de Azure-portal en ga naar uw API Management-exemplaar.
Selecteer in het linkernavigatievenster Products (Producten) > + Add (Toevoegen).

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

Product toevoegen in de portal

Naam	Beschrijving
Weergavenaam	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.
Status	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 dit als een gebruiker een abonnement moet hebben om het product te kunnen gebruiken.
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	Beperk eventueel het aantal gelijktijdige abonnementen.
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.

Klik op Create (Maken) om een nieuw product te maken.

Als u Azure CLI wilt gaan gebruiken, gaat u als volgende te werk:

Gebruik de bash-omgeving in Azure Cloud shell.
Installeer de Azure CLI, indien gewenst, om CLI-referentieopdrachten uit te voeren.
- 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 de 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	Beschrijving
`--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 dit als een gebruiker een abonnement moet hebben om het product te kunnen gebruiken.
`--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`	Beperk eventueel het aantal gelijktijdige abonnementen.
`--legal-terms`	U kunt ook de gebruiksvoorwaarden voor het product opnemen, die abonnees moeten accepteren om het product te kunnen gebruiken.

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 een aantal 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.

Ontwikkelaars moeten zich eerst abonneren op een product om toegang tot de API te krijgen. Wanneer ontwikkelaars zich abonneren, ontvangen ze een abonnementssleutel die toegang biedt tot elke API in het betreffende product. Als u de APIM-abonnementssleutel hebt gemaakt, bent u al een beheerder en bent u standaard geabonneerd op elk product.

Een API toevoegen aan een bestaand product

Portal
Azure-CLI

Selecteer Products (Producten) in de linkernavigatie van uw API Management-exemplaar.
Selecteer een product en selecteer vervolgens API's.
Selecteer + Toevoegen.
Selecteer een of meer API's en vervolgens Select (Selecteren).

API toevoegen aan bestaand product

Als u uw beheerde API's wilt zien, gebruikt u de opdracht az apim api list:

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

Voer de opdracht az apim product api add uit om een API toe te voegen aan uw product:

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

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

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.

Volgende stappen

In deze zelfstudie heeft u het volgende geleerd:

Een product maken en publiceren
Een API toevoegen aan het product

Ga door naar de volgende zelfstudie:

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