Oktatóanyag: Termék létrehozása és közzététele

A KÖVETKEZŐRE VONATKOZIK: Minden API Management-szint

Az Azure API Managementben egy termék egy vagy több API-t, használati kvótát és használati feltételeket tartalmaz. A termék közzététele után a fejlesztők feliratkozhatnak a termékre, és elkezdhetik használni a termék API-jait.

Ebben az oktatóanyagban az alábbiakkal fog megismerkedni:

• Termékek létrehozása és közzététele
• API hozzáadása a termékhez
• Termék API-k elérése

Előfeltételek

• Az Azure API Management terminológiájának ismerete.
• Tekintse át a következő rövid útmutatót: Azure API Management-példány létrehozása.
• Végezze el a következő oktatóanyagot is: Az első API importálása és közzététele.

Termékek létrehozása és közzététele

Portál

1. Jelentkezzen be az Azure Portalra, és keresse meg az API Management-példányt.

2. A bal oldali navigációs panelen válassza a Termékek>+ Hozzáadás lehetőséget.

   

3. A Termék hozzáadása ablakban adja meg a következő táblázatban leírt értékeket a termék létrehozásához.

   

   Név	Leírás
   Megjelenített név	A név, ahogyan szeretné, megjelenik a fejlesztői portálon.
   Leírás	Adja meg a termékkel kapcsolatos információkat, például a célját, a hozzáférést biztosító API-kat és egyéb részleteket.
   Állapot	Válassza a Közzétéve lehetőséget, ha közzé szeretné tenni a terméket. Mielőtt meghívhatná egy termék API-jait, közzé kell tenni a terméket. Alapértelmezés szerint az új termékek nem jelennek meg, és csak a Rendszergazda istrators csoport számára láthatók.
   Előfizetés szükséges	Válassza ki, hogy egy felhasználónak elő kell-e fizetnie a termék használatához (a termék védett), és egy előfizetési kulcsot kell használnia a termék API-iinak eléréséhez. Ha nincs szükség előfizetésre (a termék nyitva van), a termék API-ihoz való hozzáféréshez nincs szükség előfizetési kulcsra. A cikk későbbi részében tekintse meg a termék API-khoz való hozzáférést.
   Jóváhagyást igényel	Válassza ki, ha azt szeretné, hogy egy rendszergazda tekintse át és fogadja el vagy utasítsa el a termékre vonatkozó előfizetési kísérleteket. Ha nincs kiválasztva, az előfizetési kísérletek automatikusan jóvá lesznek hagyva.
   Előfizetések számának korlátozása	Igény szerint korlátozhatja több egyidejű előfizetés számát.
   Jogi feltételek	Megadhatja a termék használati feltételeit, amelyeket az előfizetőknek el kell fogadniuk, hogy használni tudják a terméket.
   API-k	Jelöljön ki egy vagy több API-t. A termék létrehozása után API-kat is hozzáadhat. További információ: API-k hozzáadása egy termékhez a cikk későbbi részében. Nyílt (előfizetést nem igénylő) termék esetén csak olyan API-t adhat hozzá, ami nincs egy másik nyílt termékhez társítva.

4. Válassza a Létrehozás lehetőséget az új termék létrehozásához.

Figyelemfelhívás

Ügyeljen arra, hogy olyan terméket konfiguráljon, amely nem igényel előfizetést. Ez a konfiguráció túlságosan megengedő lehet, és sebezhetőbbé teheti a termék API-jait bizonyos API-biztonsági fenyegetésekkel szemben.

Azure CLI

Az Azure CLI használatának megkezdése:

• Használja a Bash-környezetet az Azure Cloud Shellben. További információ: A Bash rövid útmutatója az Azure Cloud Shellben.

  

• Ha inkább helyi cli-referenciaparancsokat szeretne futtatni, telepítse az Azure CLI-t. Ha Windows vagy macOS rendszert használ, fontolja meg az Azure CLI Docker-tárolóban való futtatását. További információ: Az Azure CLI futtatása Docker-tárolóban.

  • Ha helyi telepítést használ, jelentkezzen be az Azure CLI-be az az login parancs futtatásával. A hitelesítési folyamat befejezéséhez kövesse a terminálon megjelenő lépéseket. További bejelentkezési lehetőségekért lásd : Bejelentkezés az Azure CLI-vel.

  • Amikor a rendszer kéri, először telepítse az Azure CLI-bővítményt. További információ a bővítményekről: Bővítmények használata az Azure CLI-vel.

  • Futtassa az az version parancsot a telepített verzió és a függő kódtárak megkereséséhez. A legújabb verzióra az az upgrade paranccsal frissíthet.

Termék létrehozásához futtassa az az apim product create parancsot:

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

A termékhez különböző értékeket adhat meg:

Paraméter	Leírás
--product-name	A név, ahogyan szeretné, megjelenik a fejlesztői portálon.
--description	Adja meg a termékkel kapcsolatos információkat, például a célját, a hozzáférést biztosító API-kat és egyéb részleteket.
--state	Válassza a közzétett lehetőséget, ha közzé szeretné tenni a terméket. Mielőtt meghívhatná egy termék API-jait, közzé kell tenni a terméket. Alapértelmezés szerint az új termékek nem jelennek meg, és csak a Rendszergazda istrators csoport számára láthatók.
--subscription-required	Válassza ki, hogy egy felhasználónak elő kell-e fizetnie a termék használatára (a termék védett), vagy nincs szükség előfizetésre (a termék nyitva van). A cikk későbbi részében tekintse meg a termék API-khoz való hozzáférést.
--approval-required	Válassza ki, ha azt szeretné, hogy egy rendszergazda tekintse át és fogadja el vagy utasítsa el a termékre vonatkozó előfizetési kísérleteket. Ha nincs kiválasztva, az előfizetési kísérletek automatikusan jóvá lesznek hagyva.
--subscriptions-limit	Igény szerint korlátozhatja több egyidejű előfizetés számát.
--legal-terms	Belefoglalhatja a termék használati feltételeit, amelyeket az előfizetőknek el kell fogadniuk a termék használatához.

Figyelemfelhívás

Ügyeljen arra, hogy olyan terméket konfiguráljon, amely nem igényel előfizetést. Ez a konfiguráció túlságosan megengedő lehet, és sebezhetőbbé teheti a termék API-jait bizonyos API-biztonsági fenyegetésekkel szemben.

Az aktuális termékek megtekintéséhez használja az az apim terméklista parancsot:

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

A terméket az az apim terméktörlés parancsával törölheti:

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

További konfigurációk hozzáadása

A mentés után folytassa a termék konfigurálását. Az API Management-példányban válassza ki a terméket a Termékek ablakban. Hozzáadás vagy frissítés:

Elem	Leírás
Beállítások	Termék metaadatai és állapota
API-k	A termékhez társított API-k
Házirendek	Termék API-kra alkalmazott szabályzatok
Hozzáférés-vezérlés	Termékláthatóság fejlesztők vagy vendégek számára
Előfizetések	Termék-előfizetők

API-k hozzáadása termékekhez

A termékek egy vagy több API társításai. Több API-t is megadhat, és a fejlesztői portálon elérhetővé teheti azokat a fejlesztők számára. A termék létrehozása során hozzáadhat egy vagy több meglévő API-t. Később api-kat is hozzáadhat a termékhez, akár a Termékek Gépház lapon, akár api létrehozásakor.

API hozzáadása meglévő termékhez

Portál

1. Az API Management-példány bal oldali navigációs sávjában válassza a Termékek lehetőséget.
2. Válasszon ki egy terméket, majd válassza az API-kat.
3. Válassza az + API hozzáadása lehetőséget.
4. Jelöljön ki egy vagy több API-t, majd válassza ki.

Azure CLI

1. A felügyelt API-k megtekintéséhez használja az az apim api list parancsot:

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

2. Ha API-t szeretne hozzáadni a termékhez, futtassa az az apim product api add parancsot:

   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. Ellenőrizze a hozzáadást az az apim product api list paranccsal:

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

Az API-t az az apim product api delete paranccsal távolíthatja el egy termékből:

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

Hozzáférés a termék API-khoz

A termék közzététele után a fejlesztők hozzáférhetnek az API-khoz. A termék konfigurálásának módjától függően előfordulhat, hogy elő kell fizetniük a termékre a hozzáféréshez.

• Védett termék – A fejlesztőknek először elő kell fizetnie egy védett termékre, hogy hozzáférjenek a termék API-iihoz. Amikor előfizetnek, egy előfizetési kulcsot kapnak, amely a termék bármely API-ját elérheti. Ha létrehozta az API Management-példányt, ön már rendszergazda, ezért alapértelmezés szerint minden termékre előfizetett. További információ: Előfizetések az Azure API Managementben.

  Amikor egy ügyfél érvényes termék-előfizetési kulccsal küld API-kérést, az API Management feldolgozza a kérést, és engedélyezi a hozzáférést a termék kontextusában. A termékhez konfigurált szabályzatok és hozzáférés-vezérlési szabályok alkalmazhatók.

  Tipp.

  A felhasználó előfizetését egy REST API- vagy PowerShell-paranccsal hozhatja létre vagy frissítheti egy termékre egyéni előfizetési kulcsokkal.

• Termék megnyitása – A fejlesztők előfizetési kulcs nélkül férhetnek hozzá egy megnyitott termék API-jához. Konfigurálhat azonban más mechanizmusokat is az API-khoz való ügyfélhozzáférés biztosításához, beleértve az OAuth 2.0-t, az ügyféltanúsítványokat és a hívó IP-címeinek korlátozását.

  Feljegyzés

  A nyílt termékek nem jelennek meg a fejlesztői portálon, hogy a fejlesztők megismerhessenek vagy feliratkozzanak rá. Csak a Rendszergazda istrators csoport számára láthatók. Egy másik mechanizmussal tájékoztatnia kell a fejlesztőket azokról az API-król, amelyek előfizetési kulcs nélkül is elérhetők.

  Ha egy ügyfél előfizetési kulcs nélkül küld API-kérést:

  • Az API Management ellenőrzi, hogy az API egy nyitott termékhez van-e társítva. Egy API legfeljebb egy nyitott termékhez társítható.

  • Ha a nyitott termék létezik, akkor a kérelem feldolgozása a nyitott termék kontextusában történik. A nyitott termékhez konfigurált szabályzatok és hozzáférés-vezérlési szabályok alkalmazhatók.

További információ: Hogyan kezeli az API Management a kéréseket előfizetési kulcsokkal vagy anélkül.

Következő lépések

Ez az oktatóanyag bemutatta, hogyan végezheti el az alábbi műveleteket:

• Termékek létrehozása és közzététele
• API hozzáadása a termékhez
• Termék API-k elérése

Folytassa a következő oktatóanyaggal:

Üres API és API-válaszok utánzásának létrehozása