Az API-k közzétevőjeként olyan webhelyre van szüksége, amely hatékonyan forgalmazhatja az API-kat, és segít az ügyfeleknek különbséget tenni az ajánlatok között. Amikor kiválasztották az API-kat, csak hitelesített felhasználók számára kell hozzáférést biztosítania, kezelnie kell a használatot, és pontos számlákat kell szolgáltatnia a használatra. Ez a példaforgatókönyv bemutatja, hogyan hozhat létre olyan platformot az Azure service és a GitHub használatával, amely mindezt és még sok mást is végrehajt.
Felépítés
Töltse le az architektúra PowerPoint-fájlját.
Adatfolyam
A megoldás elsősorban a következő építőelemekből áll:
Monetized back-end API-k > API-átjáró. A megoldás középpontjában a bevételezett háttér API-k állnak. A felhasználók, például a felhasználók, alkalmazások és eszközök api-átjárón keresztül férnek hozzá az API-platformhoz. Az átjáró szabályozza a kéréseket, és szükség szerint alkalmazza a sebességszintezést.
Fogyasztói portál és alkalmazások. Az API-platform felhasználói böngésznek az API-ajánlatok között, regisztrálnak, majd előfizetési kulcsokat hoznak létre a különböző API-végpontok eléréséhez. A megoldás fiókkezelési funkcióival frissíthetik a fiókjukkal és a számlázásukkal kapcsolatos információkat.
Rendszergazda a különböző portálok és alkalmazások. A platformgazdák közzéteszik az API-termékek listáját, azok díjszabását és díjcsomagjait. Ezek a portálok a különböző API-termékek használatával kapcsolatos részletes elemzéseket is kínálnak, amelyek segítenek a problémák elhárításában és a támogatási szolgáltatások nyújtásában.
Üzletági szolgáltatások. Ezek a szolgáltatások a fogyasztói portálok és alkalmazások funkcióinak biztosításához és a megoldásban támogatott különböző felhasználói folyamatok támogatásához szükségesek.
API-használatkövetési és díjszámítási motor. Az API-átjáró rétegében rögzített API-használati jelentések rendszeres időközönként külön adattárba lesznek exportálva. Az ütemezett feladatok ezen adatokon futnak, hogy kiszámítsák a fogyasztói fiókokra vonatkozó díjakat az előfizetések listája és a társított díjszabási modell alapján.
A megoldás feldolgozási sorrendje az alábbiak szerint halad:
Az API-közzétevő az Azure Portal használatával importálja az API-specifikációkat, termék szerint csoportosítja és közzéteszi őket.
Az API-közzétevő frissíti a termékekkel kapcsolatos marketinginformációkat a megfelelő GitHub-adattárban.
Az API-felhasználó hozzáfér a marketplace portálhoz, böngészi a különböző termékeket, és kiválaszt egy adott API-szolgáltatást.
Amikor a fogyasztó megkísérli megtekinteni az API-szolgáltatással kapcsolatos további információkat, a fogyasztói portál átirányítja a fogyasztót a GitHubon üzemeltetett továbbfejlesztett fejlesztői portálra, amely a GitHub-oldalakat használja.
A fogyasztó böngészhet a különböző API-specifikációkban, a fejlesztővel kapcsolatos információkban, és akár egy hasznos adatmintával is megpróbálhat végpontot invokálásra.
A fogyasztó regisztrál a platformon, majd aktivál egy előfizetést az adott API-szolgáltatáshoz, amelyet használni szeretne.
A fogyasztó az API-szolgáltatást az alkalmazásaikban vagy eszközeiken használja.
Az API meghívása metrikákat hoz létre a használatról és a felhasználásról, amelyeket az Azure tárol a nyomkövetési adatbázisokban.
A használati adatok rendszeres exportálása és mentése egy egyéni adatbázisba, jellemzően egy adattóba további elemzés céljából történik.
A háttérfeladat a használati adatokból és a különböző előfizetésekből számítja ki a díjakat.
A számla és a fizetéssel kapcsolatos információk a könyvelési adatbázisban találhatók. Ez az információ a szolgáltatás bevételének kiszámítására szolgál.
Összetevők
A megoldás a következő szolgáltatásként nyújtott szoftverekből (SaaS-ajánlatokból) áll:
Az Azure API Management egy felügyelt platform szolgáltatásként, amely lehetővé teszi a szervezetek számára, hogy API-kat tegyenek közzé mind a belső, mind a külső fogyasztók számára. Az API Management használatával bárhol közzéteheti azokat az API-kat, amelyek bárhol üzemeltethetők. Az API Management alapvetően lehetővé teszi az API-üzemeltetés leválasztását a közzétett átjáróról, amely egyetlen belépési pontként szolgál a vállalat által közzétett API-k teljes környezetéhez. További információ: Átjáró-útválasztási minta.
Az API Management emellett az összes közzétett API-n felül egy szabályozási réteget is biztosít. Az API Management-szabályzatok, más képességek, például a sebességkorlátok és a kvóták használatával szabályozhatja az API-kéréseket egy kulcs vagy előfizetés alapján. Az API Management tartalmaz egy fejlesztői portált , amely egy teljesen testre szabható webhelyet biztosít, amely a rajta keresztül közzétett API-k dokumentációjaként szolgál.
A GitHub a Microsoft népszerű SaaS-ajánlata, amelyet a fejlesztők gyakran használnak szoftverprojektjeik összeállítására, szállítására és karbantartására. Fontos funkciókat biztosít, amelyeket a megoldásokban használhat:
A GitHub Pages lehetővé teszi a vállalat számára, hogy gazdag HTML-alapú webhelyet üzemeltetjen közvetlenül egy GitHub-adattárból.
A GitHub-vitafórumok és a GitHub-problémák segítenek a közösségi együttműködés aktiválásában.
Azure-alkalmazás szolgáltatás egy teljesen felügyelt számítási platform egyéni webalkalmazások üzemeltetéséhez.
Az Azure Active Directory B2C (Azure AD B2C) a Microsoft Entra ID bővítménye, amellyel az alkalmazás külső ügyfél- vagy partneri identitásokat kezelhet a hozzáféréshez és engedélyezéshez. A Microsoft azonosítási platformjának használatával egyszerűen integrálhatja az identitást és az engedélyezést az egyéni alkalmazásokban.
Forgatókönyv részletei
Az API-platformok sikeressége és bevezetése nagyban függ attól, hogy milyen magas szintűnek tekinthető a piactéren. A platform által kínált digitális eszközökön túl az API-k könnyű megtalálása és a használatuk egyszerűsége nagy hatással van arra, hogy az ügyfelek használnak-e platformot. Az ügyfeleknek meg kell tudniuk találni a dokumentációt, és támogatást kell kapniuk a problémákhoz. A platformnak közösségi hozzájárulást is kell nyújtania ahhoz, hogy az ügyfelek igényeiknek megfelelően alakíthassák az API-kat. Az API-k közzétevőjeként olyan webhelyre van szüksége, amely hatékonyan forgalmazhatja az API-kat, és segít az ügyfeleknek különbséget tenni az ajánlatok között. Amikor kiválasztották az API-kat, csak hitelesített felhasználók számára kell hozzáférést biztosítania, kezelnie kell a használatot, és pontos számlákat kell szolgáltatnia a használatra. Ez a példaforgatókönyv bemutatja, hogyan hozhat létre olyan platformot az Azure service és a GitHub használatával, amely mindezt és még sok mást is végrehajt.
Lehetséges használati esetek
Ez a megoldás megkönnyíti az API-fejlesztők számára a következőket:
- Fedezze fel és ismerje meg API-termékajánlatait.
- Iratkozzon fel és integráljon a különböző alkalmazásokkal és csatornákkal.
- Segítségkérés, problémák elhárítása és problémák elhárítása.
- Közösségi közreműködés elősegítése, ötletek és tudás cseréje.
API-értéklánc
Az értéklánc tetején található az API-szolgáltató. A következő az API-felhasználók vagy integrátorok, akik a végső célfelhasználók számára tervezik és építik ki a szolgáltatásokat. Az értéklánc végső kedvezményezettjei a végfelhasználók és az ügyfelek.
API fejlesztői élmény
Töltse le a diagram PowerPoint-fájlját.
Az API fejlesztői felülete három portált tartalmaz:
Fogyasztói portál. A fogyasztói portál marketinges webhelyként szolgál, amely bemutatja a vállalat által kínált különböző API-termékeket.
Fejlesztői portál. A fejlesztői portál dokumentációt nyújt a külső fejlesztőknek a különböző API-szolgáltatásokról és azok alkalmazásukban való használatáról.
Fiókportál. A regisztrált felhasználók a fiókportálon kezelhetik előfizetéseiket, és egyéb fiókokkal kapcsolatos tevékenységeket hajthatnak végre.
Funkcionális követelmények
Magas szinten a nagyvállalati szintű API-platform funkcionális követelményei három kategóriába sorolhatók: a termékkel, a platformfelügyelettel és a fogyasztói élményekkel.
Az alábbi szakaszok az egyes funkciókon belüli képességeket ismertetik.
Termékbeszerzés
A termékbeszerzés célja a bevételt képező API-k, azok kezelése és a digitális termékekként való értékesítés stratégiájának azonosítása és meghatározása. Ennek eredményeképpen a következőkre terjed ki:
- Képességek, például a termékek variánsainak azonosítása és azok fizikai eszközökhöz való megfelelő leképezése.
- A díjszabási és díjcsomagok definíciója a szükséges metaadatokkal együtt.
- Olyan tartalom, amelyet létre kell hozni a fogyasztói élmény érdekében.
A termékbeszerzés a következő képességeket foglalja magában:
API-termékek. Az API-k katalógusa elérhetővé válik a felhasználók számára. A termék megvásárolható vagy ingyenes szolgáltatásként is használható.
Változatok. A fejlesztői felületnek azonosítania kell a monetizált API-termékek variánsait.
Tarifacsomagok. Határozza meg a különböző díjszabási terveket, hogy vonzóvá tegyék a fogyasztók számára.
Osztályozás és tartalom. Definiálja és hozza létre az API-termékek marketingstratégiához szükséges tartalmat – szöveges, PDF-fájlokat, képeket stb.
Fizikai eszközök. Ez az adott API-termék részét képező tényleges felhőszolgáltatásokból és azok megfelelő életciklus-felügyeletéből áll. Vegye figyelembe a szolgáltatások fenntartásának üzemeltetési költségeit a tarifacsomagok levezetése során.
Platformfelügyelet
A platformfelügyelet az API-platform általános üzemeltetésére, felügyeletére és irányítására összpontosít. Emellett a különböző üzletági alkalmazások és szolgáltatások felügyeletére is kínál végpontok közötti megoldást. A fő területek az előfizetés-kezelés, a számlázás és a számlázás. A platformfelügyelet emellett üzleti elemzéseket és elemzéseket is biztosít a szolgáltatás általános állapotának bemutatásához, beleértve annak pénzügyi és működési szempontjait is.
A platformfelügyelet a következő képességeket foglalja magában:
Felhasználói regisztráció. Azonosítsa, hogy a felhasználók hogyan regisztrálnak a platformon. A felhasználói szegmenstől függően definiálja a szükséges jóváhagyási munkafolyamatokat.
API-katalógus. Azonosítsa az API Managementen keresztül közzétett API-objektumokat. Szabályzatok alkalmazása az API-k hozzáférésének és használatának szabályozásához. A felhasználók előfizetéseinek kezelése.
Elemzések és elemzés. Telemetriai adatok rögzítése különböző metrikák létrehozásához. Az adatokat különböző irányítópultok, például a Power BI használatával jelenítheti meg az üzleti és informatikai döntéshozók számára szükséges különböző elemzések kinyeréséhez.
Számlázás és számlázás. Határozza meg az előfizetésekhez, a rendeléskezeléshez, a számlázáshoz és a számlázáshoz kapcsolódó munkafolyamatokat.
Támogatás. Eszközök és folyamatok létrehozása a támogatási kérelmek kezeléséhez.
Felhasználói élmény
Az API-platform bevezetése nagymértékben függ attól, hogy a felhasználók milyen könnyen:
- Fedezze fel a szükséges API-kat.
- Tekintse át a specifikációt és a műszaki tartalmat a fejlesztői portálon való böngészéssel.
- Regisztráljon a feliratkozáshoz.
- A kiválasztott API-termékekért fizethet.
- Kezdje el használni az API-kat az alkalmazásaikban.
A felhasználói élmény általában egy webportálon, egy mobilalkalmazáson vagy mindkettőn keresztül érhető el. Az Azure AD B2C-vel megkönnyítheti a felhasználók regisztrálását és identitáskezelését. Az Azure AD B2C támogatja az OpenID identitásszolgáltatókat, például a Microsoftot és a Google-t.
A fogyasztói élmény a következő összetevőkből áll:
Termékkatalógus (API). Hozzon létre egy marketplace-felületet a névtelen és a regisztrált felhasználók számára.
Fiók- és előfizetés-kezelés. Az API használatára váró felhasználók típusai alapján hozzon létre eljárásokat a regisztrációhoz és a bejelentkezéshez. A felhasználói beállítások támogatása, például a meglévő közösségi identitásszolgáltatók használata. Lehetővé teszi az önkiszolgáló előfizetések kezelését, az aktiválási és inaktiválási szolgáltatásokat, valamint a számlázott díjak kifizetését.
Felhasználói felület (UI) / Felhasználói élmény (UX). Azonosítsa és határozza meg a végfelhasználói élményekhez támogatott csatornák felhasználói élményét. Többeszközes, többalakos tényezős képességek, valamint modern felhasználói felületi kialakítás. Bővítse a tapasztalatot használhatósági tanulmányok segítségével.
Considerations
Az ebben a forgatókönyvben szereplő összetevők a teljesítmény, a megbízhatóság és a biztonság problémáival foglalkoznak.
Az API Management támogatja az automatikus skálázást, amely gyorsan kiterjeszti az API Management képességeit a bejövő kérelmek növekvő száma miatt. Az API Management támogatja a zónaredundanciát és a többrégiós üzemelő példányokat is, hogy rugalmasságot és magas rendelkezésre állást biztosítson. További információ a zónaredundanciáról: Rendelkezésre állási zónák támogatása az Azure API Managementhez. További információ az API Management biztonságáról: Azure biztonsági alapkonfiguráció az API Managementhez.
Az App Service egy teljes körűen felügyelt platform, amely beépített biztonságot és automatikus skálázást biztosít magas rendelkezésre állást ígérő SLA-val . Az App Service ISO-, SOC- és PCI-kompatibilis, és microsoft entra-azonosítóval, Google-, Facebook-, Twitter- vagy Microsoft-fiókkal támogatja a felhasználók hitelesítését. Az App Service-ben IP-címkorlátozásokat is létrehozhat.
Az Azure AD B2C magas rendelkezésre állást és skálázást kínál több száz millió felhasználó támogatásához. Az Azure AD B2C támogatja az OpenID Csatlakozás és több identitásszolgáltatót, hogy az ügyfelek kiválaszthassák előnyben részesített szolgáltatójukat. Az Azure AD B2C az alkalmazásalapú és szabályzatalapú többtényezős hitelesítést is támogatja, további biztonsági rétegeket adva hozzá. További információ az Azure AD B2C-ről: Mi az Az Azure Active Directory B2C? További információ a külső identitások használatáról: Külső identitások a Microsoft Entra ID-ban.
A GitHub a kódértékelések automatikus részét képezi a biztonsági felülvizsgálatoknak, és minden új véglegesítést megvizsgál a lehetséges biztonsági problémákat keresve. Ez a szolgáltatás segít a problémák felderítésében, amint a kódbázis kiegészítéseként felajánlják őket. A GitHub biztonságával testre szabhatja a biztonsági problémák kereséseit, és integrálhatja a külső ellenőrzőmotorokat. További funkciókért és részletekért lásd : Biztonság a GitHubon.
Költségoptimalizálás
A fogyasztói portált a GitHub csapat- vagy nagyvállalatidíjszabási csomagjának használatával fejlesztheti. A funkciómátrix segítségével megállapíthatja, hogy melyik csomag felel meg a legjobban a vállalatnak.
Az API Managementhez használhatja a Standard vagy a Prémium szinteket. A szintek közötti különbségek jobb megértéséhez tekintse meg az API Management díjszabási lehetőségeit.
A Azure-alkalmazás szolgáltatás esetében tekintse meg az alkalmazásokat futtató Windows- és Linux-környezetekhez elérhető díjszabási lehetőségeket.
Közreműködők
Ezt a cikket a Microsoft tartja karban. Eredetileg a következő közreműködők írták.
Fő szerző:
- Subhajit Chatterjee | Vezető szoftvermérnök, iparági felhők
További lépések
- Bevételszerzés az Azure API Managementtel
- A fejlesztői portál áttekintése az Azure API Managementben
- Az API Management fejlesztői portál önálló üzemeltetése
- Saját üzemeltetésű átjáró
- A GitHub Pages használatának első lépései