Självstudier: Skapa och publicera en produkt

GÄLLER FÖR: Alla API Management-nivåer

I Azure API Management innehåller en produkt en eller flera API:er, en användningskvot och användningsvillkoren. När en produkt har publicerats kan utvecklare prenumerera på produkten och börja använda produktens API:er.

I den här självstudien lär du dig att:

• Skapa och publicera en produkt
• Lägga till ett API till produkten
• Åtkomst till produkt-API:er

Förutsättningar

• Lär dig Azure API Management-terminologin.
• Slutför följande snabbstart: Skapa en Azure API Management-instans.
• Slutför även följande självstudie: Importera och publicera ditt första API.

Skapa och publicera en produkt

Portal

1. Logga in på Azure-portalen och gå till din API Management-instans.

2. I det vänstra navigeringsfönstret väljer du Produkter>+ Lägg till.

   

3. I fönstret Lägg till produkt anger du värden som beskrivs i följande tabell för att skapa produkten.

   

   Name	beskrivning
   Display name	Namnet som du vill att det ska visas i utvecklarportalen.
   beskrivning	Ange information om produkten, till exempel dess syfte, de API:er som den ger åtkomst till och annan information.
   Tillstånd	Välj Publicerad om du vill publicera produkten. Produkten måste vara publicerad innan API:er i en produkt kan anropa den. Som standard avpubliceras nya produkter och visas endast för gruppen Administratörer .
   Prenumeration krävs	Välj om en användare måste prenumerera för att använda produkten (produkten är skyddad) och en prenumerationsnyckel måste användas för att få åtkomst till produktens API:er. Om en prenumeration inte krävs (produkten är öppen) krävs ingen prenumerationsnyckel för att få åtkomst till produktens API:er. Se Åtkomst till produkt-API:er senare i den här artikeln.
   Godkännande krävs	Välj om du vill att en administratör ska granska och godkänna eller avvisa prenumerationsförsök till den här produkten. Om du inte har valt det godkänns prenumerationsförsök automatiskt.
   Antal tillåtna prenumerationer	Du kan också begränsa antalet samtidiga prenumerationer.
   Juridiska villkor	Du kan inkludera användningsvillkor för produkten som prenumeranter måste godkänna för att kunna använda produkten.
   API:er	Välj en eller flera API:er. Du kan också lägga till API:er när du har skapat produkten. Mer information finns i Lägga till API:er i en produkt senare i den här artikeln. Om produkten är öppen (kräver ingen prenumeration) kan du bara lägga till ett API som inte är associerat med en annan öppen produkt.

4. Välj Skapa för att skapa din nya produkt.

Varning

Var försiktig när du konfigurerar en produkt som inte kräver en prenumeration. Den här konfigurationen kan vara alltför tillåtande och kan göra produktens API:er mer sårbara för vissa API-säkerhetshot.

Azure CLI

Så här börjar du använda Azure CLI:

• Använd Bash-miljön i Azure Cloud Shell. Mer information finns i Snabbstart för Bash i Azure Cloud Shell.

  

• Om du föredrar att köra CLI-referenskommandon lokalt installerar du Azure CLI. Om du kör i Windows eller macOS kan du köra Azure CLI i en Docker-container. Mer information finns i Så här kör du Azure CLI i en Docker-container.

  • Om du använder en lokal installation loggar du in på Azure CLI med hjälp av kommandot az login. Slutför autentiseringsprocessen genom att följa stegen som visas i terminalen. Andra inloggningsalternativ finns i Logga in med Azure CLI.

  • När du uppmanas att installera Azure CLI-tillägget vid första användningen. Mer information om tillägg finns i Använda tillägg med Azure CLI.

  • Kör az version om du vill hitta versionen och de beroende bibliotek som är installerade. Om du vill uppgradera till den senaste versionen kör du az upgrade.

Skapa en produkt genom att köra kommandot az apim product create :

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

Du kan ange olika värden för din produkt:

Parameter	Description
--product-name	Namnet som du vill att det ska visas i utvecklarportalen.
--description	Ange information om produkten, till exempel dess syfte, de API:er som den ger åtkomst till och annan information.
--state	Välj publicerad om du vill publicera produkten. Produkten måste vara publicerad innan API:er i en produkt kan anropa den. Som standard avpubliceras nya produkter och visas endast för gruppen Administratörer .
--subscription-required	Välj om en användare måste prenumerera för att använda produkten (produkten är skyddad) eller om en prenumeration inte krävs (produkten är öppen). Se Åtkomst till produkt-API:er senare i den här artikeln.
--approval-required	Välj om du vill att en administratör ska granska och godkänna eller avvisa prenumerationsförsök till den här produkten. Om du inte har valt det godkänns prenumerationsförsök automatiskt.
--subscriptions-limit	Du kan också begränsa antalet samtidiga prenumerationer.
--legal-terms	Du kan inkludera användningsvillkoren för produkten, som prenumeranter måste godkänna för att använda produkten.

Varning

Var försiktig när du konfigurerar en produkt som inte kräver en prenumeration. Den här konfigurationen kan vara alltför tillåtande och kan göra produktens API:er mer sårbara för vissa API-säkerhetshot.

Om du vill se dina aktuella produkter använder du kommandot az apim product list :

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

Du kan ta bort en produkt med kommandot 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

Lägga till fler konfigurationer

Fortsätt att konfigurera produkten när du har sparat den. I din API Management-instans väljer du produkten i fönstret Produkter . Lägg till eller uppdatera:

Objekt	beskrivning
Inställningar	Produktmetadata och tillstånd
API:er	API:er som är associerade med produkten
Principer	Principer som tillämpas på produkt-API:er
Åtkomstkontroll	Produktsynlighet för utvecklare eller gäster
Prenumerationer	Produktprenumeranter

Lägga till API:er till en produkt

Produkter är associationer med en eller flera API:er. Du kan inkludera flera API:er och erbjuda dem till utvecklare via utvecklarportalen. När produkten skapas kan du lägga till en eller flera befintliga API:er. Du kan också lägga till API:er i produkten senare, antingen från sidan Produkter Inställningar eller när du skapar ett API.

Lägga till en API till en befintlig produkt

Portal

1. I det vänstra navigeringsfältet för din API Management-instans väljer du Produkter.
2. Välj en produkt och välj sedan API:er.
3. Välj + Lägg till API.
4. Välj en eller flera API:er och sedan Välj.

Azure CLI

1. Om du vill se dina hanterade API:er använder du kommandot az apim api list :

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

2. Om du vill lägga till ett API i din produkt kör du kommandot az apim product api add :

   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. Verifiera tillägget med kommandot 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
   

Du kan ta bort ett API från en produkt med kommandot 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

Åtkomst till produkt-API:er

När du har publicerat en produkt kan utvecklare komma åt API:erna. Beroende på hur produkten har konfigurerats kan de behöva prenumerera på produkten för åtkomst.

• Skyddad produkt – Utvecklare måste först prenumerera på en skyddad produkt för att få åtkomst till produktens API:er. När de prenumererar får de en prenumerationsnyckel som kan komma åt alla API:er i produkten. Om du har skapat API Management-instansen är du redan administratör, så du prenumererar som standard på varje produkt. Mer information finns i Prenumerationer i Azure API Management.

  När en klient gör en API-begäran med en giltig produktprenumerationsnyckel bearbetar API Management begäran och tillåter åtkomst i produktens kontext. Principer och åtkomstkontrollregler som konfigurerats för produkten kan tillämpas.

  Dricks

  Du kan skapa eller uppdatera en användares prenumeration till en produkt med anpassade prenumerationsnycklar via ett REST-API eller PowerShell-kommando.

• Öppna produkt – Utvecklare kan komma åt en öppen produkts API:er utan en prenumerationsnyckel. Du kan dock konfigurera andra mekanismer för att skydda klientåtkomsten till API:erna, inklusive OAuth 2.0, klientcertifikat och begränsa anroparens IP-adresser.

  Kommentar

  Öppna produkter visas inte i utvecklarportalen där utvecklare kan lära sig mer om eller prenumerera på. De är bara synliga för gruppen Administratörer . Du måste använda en annan mekanism för att informera utvecklare om API:er som kan nås utan en prenumerationsnyckel.

  När en klient gör en API-begäran utan en prenumerationsnyckel:

  • API Management kontrollerar om API:et är associerat med en öppen produkt. Ett API kan associeras med högst en öppen produkt.

  • Om den öppna produkten finns bearbetas begäran i kontexten för den öppna produkten. Principer och åtkomstkontrollregler som konfigurerats för den öppna produkten kan tillämpas.

Mer information finns i Hur API Management hanterar begäranden med eller utan prenumerationsnycklar.

Nästa steg

I den här självstudiekursen lärde du dig att:

• Skapa och publicera en produkt
• Lägga till ett API till produkten
• Åtkomst till produkt-API:er

Gå vidare till nästa kurs:

Skapa en tom API och testa API-svaren