Zelfstudie: Een product maken en publiceren

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
  • Product-API's openen

API Management products in portal

Vereisten

Een product maken en publiceren

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

  2. Selecteer Producten>+ Toevoegen in het linkernavigatiedeelvenster.

    Add product in Azure portal

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

    Add product window

    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 de groep Administrators .
    Abonnement is vereist Selecteer of een gebruiker zich moet abonneren op het gebruik van het product (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 er geen abonnementssleutel vereist voor toegang tot de API's van het product. Zie Access voor 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 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.

    Als het product is geopend (waarvoor geen abonnement is 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.

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 veel API's opnemen en deze aanbieden aan 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

  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.

Add an API to an existing product

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 geopend 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.

    Wanneer een client een API-aanvraag doet zonder abonnementssleutel:

    • API Management controleert of de API is gekoppeld aan een geopend product.

    • 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)