Jako vydavatel rozhraní API potřebujete web, který efektivně trhá vaše rozhraní API a pomáhá zákazníkům rozlišovat mezi nabídkami. Když vyberete rozhraní API, musíte být schopni udělit přístup pouze ověřeným uživatelům, správě spotřeby a poskytování přesných faktur za použití. Tento ukázkový scénář ukazuje, jak pomocí služby Azure a GitHubu vytvořit platformu, která to všechno dělá a další.
Architektura
Stáhněte si soubor PowerPointu této architektury.
Tok dat
Řešení se primárně skládá z následujících stavebních bloků:
Zpeněžená back-endová rozhraní API a brána rozhraní API Jádrem řešení je sada back-endových rozhraní API, která jsou zpeněžená. Uživatelé, jako jsou uživatelé, aplikace a zařízení, přistupují k platformě rozhraní API prostřednictvím brány rozhraní API. Brána omezuje požadavky a podle potřeby používá vyrovnání rychlosti.
Uživatelský portál a aplikace. Uživatelé platformy API procházejí nabídky rozhraní API, zaregistrují a potom vygenerují klíče předplatného pro přístup k různým koncovým bodům rozhraní API. Informace o svých účtech a fakturaci můžou aktualizovat pomocí funkcí správy účtů řešení.
Správa istrativní portály a aplikace. Správci platforem publikují seznam produktů rozhraní API, jejich cen a plánů sazeb. Tyto portály také nabízejí bohatou analýzu použití různých produktů rozhraní API, které pomáhají řešit problémy a nabízet služby podpory.
Obchodní služby. Tyto služby jsou potřeba k poskytování funkcí uživatelských portálů a aplikací a k podpoře různých cest uživatelů podporovaných v řešení.
Modul pro sledování spotřeby rozhraní API a poplatky Sestavy spotřeby rozhraní API zachycené ve vrstvě brány rozhraní API se pravidelně exportují do samostatného úložiště dat. Naplánované úlohy se spouštějí na těchto datech, aby se vypočítaly poplatky, které se vztahují na jakýkoli uživatelský účet, na základě svého seznamu předplatných a přidruženého cenového modelu.
Pořadí zpracování v tomto řešení tokuje takto:
Vydavatel rozhraní API importuje specifikace rozhraní API pomocí webu Azure Portal, seskupí je podle produktu a publikuje je.
Vydavatel rozhraní API aktualizuje marketingové informace související s produktem v odpovídajícím úložišti GitHub.
Příjemce rozhraní API přistupuje k portálu Marketplace, prochází různé produkty a vybere konkrétní službu rozhraní API.
Když se uživatel pokusí zobrazit další informace o službě API, portál příjemce přesměruje uživatele na vylepšený portál pro vývojáře, který je hostovaný na GitHubu a používá stránky GitHubu.
Uživatel může procházet různé specifikace rozhraní API, informace související s vývojářem a dokonce se pokusit o vyvolání koncového bodu pomocí ukázkové datové části.
Příjemce se zaregistruje na platformě a pak aktivuje předplatné pro konkrétní službu API, kterou má zájem o použití.
Uživatel používá službu API ve svých aplikacích nebo zařízeních.
Vyvolání rozhraní API generuje metriky týkající se jejího použití a spotřeby, které jsou uložené v Azure při sledování databází.
Data o spotřebě se pravidelně exportují a ukládají do vlastní databáze, obvykle data lake, pro další analýzu.
Back-endová úloha vypočítá poplatky z dat o spotřebě a různých předplatných.
Informace související s fakturou a platbou se ukládají v databázi účtů. Tyto informace slouží k výpočtu výnosů služby.
Komponenty
Řešení se skládá z následujících nabídek saas (software jako služba):
Azure API Management je spravovaná platforma jako služba, která organizacím umožňuje publikovat rozhraní API pro interní i externí uživatele. Pomocí služby API Management můžete publikovat rozhraní API, která se můžou hostovat kdekoli. Služba API Management v podstatě umožňuje oddělit hostování rozhraní API od publikované brány, která funguje jako jediný vstupní bod pro celou krajinu rozhraní API, která vaše organizace publikuje. Další informace najdete v tématu Model směrování brány.
API Management také poskytuje vrstvu zásad správného řízení nad všemi publikovanými rozhraními API. Pomocí zásad služby API Management můžete omezení požadavků rozhraní API na základě klíče nebo předplatného omezovat různými dalšími možnostmi, jako jsou limity rychlosti a kvóty. Služba API Management obsahuje portál pro vývojáře, který poskytuje plně přizpůsobitelný web, který bude sloužit jako dokumentace k rozhraním API, která publikujete prostřednictvím tohoto portálu.
GitHub je oblíbená nabídka SaaS od Microsoftu, kterou často používají vývojáři k vytváření, dodávání a údržbě svých softwarových projektů. Poskytuje důležité funkce, které můžete použít v řešeních:
GitHub Pages umožňuje vašemu podniku hostovat bohatý web založený na HTML přímo z úložiště GitHub.
Diskuze na GitHubu a problémy s GitHubem vám pomůžou aktivovat spolupráci komunity.
Aplikace Azure Service je plně spravovaná výpočetní platforma pro hostování vlastních webových aplikací.
Azure Active Directory B2C (Azure AD B2C) je rozšíření Microsoft Entra ID, které může vaše aplikace použít ke správě externích identit zákazníků nebo partnerů pro přístup a autorizaci. Pomocí platformy Microsoft Identify platform můžete snadno integrovat identitu a autorizaci do vlastních aplikací.
Podrobnosti scénáře
Úspěch a přijetí jakékoli platformy rozhraní API je do značné míry závislé na tom, jak vysoce se považuje na marketplace. Kromě digitálních prostředků nabízených platformou má snadné hledání rozhraní API a jejich snadné použití velký vliv na to, jestli zákazníci používají platformu. Zákazníci musí být schopni najít dokumentaci a získat podporu pro problémy. Platforma by také měla usnadnit příspěvek komunity, který vašim zákazníkům pomůže utvářet vaše rozhraní API podle jejich potřeb. Jako vydavatel rozhraní API potřebujete web, který efektivně trhá vaše rozhraní API a pomáhá zákazníkům rozlišovat mezi nabídkami. Když vyberete rozhraní API, musíte být schopni udělit přístup pouze ověřeným uživatelům, správě spotřeby a poskytování přesných faktur za použití. Tento ukázkový scénář ukazuje, jak pomocí služby Azure a GitHubu vytvořit platformu, která to všechno dělá a další.
Potenciální případy použití
Pomocí tohoto řešení můžete vývojářům rozhraní API usnadnit následující:
- Objevte a seznamte se s nabídkami produktů rozhraní API.
- Přihlaste se k odběru a integraci s různými aplikacemi a kanály.
- Získejte nápovědu, vyřešte problémy a opravte problémy.
- Propagovat příspěvek komunity a vyměňovat si nápady a znalosti.
Hodnotový řetězec rozhraní API
V horní části řetězce hodnot je poskytovatel služeb API. Dále jsou příjemci rozhraní API nebo integrátoři, kteří navrhují a sestavují prostředí pro konečné cílové uživatele. Koncoví uživatelé a zákazníci jsou konečnými příjemci v hodnotovém řetězci.
Prostředí pro vývojáře rozhraní API
Stáhněte si powerpointový soubor tohoto diagramu.
Prostředí api pro vývojáře má tři portály:
Uživatelský portál. Spotřebitelský portál slouží jako marketingový web, který prezentuje různé produkty rozhraní API, které nabízí podnik.
Portál pro vývojáře Portál pro vývojáře poskytuje vývojářům třetích stran dokumentaci k různým službám rozhraní API a jejich používání ve svých aplikacích.
Portál účtů. Registrovaní uživatelé spravují svá předplatná a provádějí další aktivity související s účty pomocí portálu účtů.
Požadavky na funkce
Na vysoké úrovni se funkční požadavky na platformu API na podnikové úrovni vejdou do tří kategorií, konkrétně do produktizace, správy platforem a uživatelských prostředí.
Následující části dále popisují možnosti v jednotlivých oblastech funkcí.
Productization
Cílem produktizace je identifikovat a definovat monetizovaná rozhraní API, jejich správu a strategii pro jejich prodej jako digitální produkty. V důsledku toho zahrnuje:
- Možnosti, jako je identifikace variant produktů a jejich odpovídající mapování na fyzické prostředky
- Definice cenových plánů a plánů sazeb spolu s potřebnými metadaty.
- Obsah, který se musí vytvořit pro řízení uživatelského prostředí.
Produktizace se skládá z následujících možností:
Produkty ROZHRANÍ API. Tento katalog rozhraní API je zpřístupněn příjemcům. Produkt může být nabízen k nákupu nebo jako bezplatná služba.
Varianty. Prostředí pro vývojáře by mělo identifikovat varianty jakéhokoli produktu rozhraní API, který je zpeněžený.
Cenové plány. Definujte různé cenové plány, aby byly pro spotřebitele atraktivní.
Taxonomie a obsah Definujte a vytvořte obsah – textové soubory, soubory PDF, obrázky atd., které jsou potřeba pro marketingovou strategii pro tyto produkty rozhraní API.
Fyzické prostředky. To se skládá ze skutečných cloudových služeb, které jsou součástí konkrétního produktu API, a jejich odpovídající správy životního cyklu. Při získávání cenových plánů zvažte provozní náklady na údržbu těchto služeb.
Správa platformy
Správa platforem se zaměřuje na celkové hostování, správu a zásady správného řízení platformy API. Poskytuje také ucelené řešení pro správu různých obchodních aplikací a služeb. Hlavními oblastmi zaměření jsou správa předplatného, fakturace a fakturace. Správa platformy také poskytuje generování obchodních přehledů a analýz, které představují celkový stav služby, včetně jejích finančních a provozních aspektů.
Správa platformy se skládá z následujících možností:
Registrace uživatele. Zjistěte, jak se uživatelé registrují na platformě. V závislosti na segmentu uživatele definujte všechny pracovní postupy schválení, které jsou nezbytné.
Katalog rozhraní API. Identifikujte prostředky rozhraní API publikované prostřednictvím služby API Management. Použijte zásady pro řízení přístupu a používání rozhraní API. Umožňuje spravovat předplatná uživatelů.
Přehledy a analýzy. Zachytávání telemetrických dat za účelem generování různých metrik Vizualizujte data pomocí různých řídicích panelů, jako je Power BI, a odvozujte různé přehledy potřebné pro pracovníky s rozhodovací pravomocí v oblasti podnikání a IT.
Fakturace a fakturace Definujte pracovní postupy související s předplatnými, správou objednávek, fakturací a fakturací.
Podpora. Vytvořte nástroje a procesy pro zpracování žádostí o podporu.
Uživatelské prostředí
Přijetí platformy ROZHRANÍ API je silně závislé na tom, jak snadno můžou uživatelé:
- Seznamte se s rozhraními API, která potřebují.
- Projděte si specifikaci a technický obsah procházením portálu pro vývojáře.
- Zaregistrujte se k odběru.
- Platíte za vybrané produkty rozhraní API.
- Začněte používat rozhraní API ve svých aplikacích.
Uživatelské prostředí se obvykle dodává prostřednictvím webového portálu, mobilní aplikace nebo obojího. Azure AD B2C můžete použít k usnadnění registrace uživatelů a správy identit. Azure AD B2C zahrnuje podporu zprostředkovatelů identity OpenID, jako je Microsoft a Google.
Uživatelské prostředí se skládá z následujících součástí:
Katalog produktů (API). Vytvořte prostředí marketplace pro uživatele, anonymní i registrované.
Správa účtů a předplatných Na základě typů uživatelů, u kterých očekáváte, že vaše rozhraní API budete používat, vytvoříte postupy pro registraci a přihlášení. Podpora uživatelských předvoleb, jako je použití stávajících zprostředkovatelů sociálních identit. Umožňuje samoobslužnou správu předplatného, aktivaci a deaktivaci a platbu poplatků jako fakturovaných.
Uživatelské rozhraní (UI) / Uživatelské prostředí (UX) Identifikujte a definujte prostředí pro kanály, které podporujete pro prostředí koncových uživatelů. Spolu s moderním návrhem uživatelského rozhraní můžete zahrnout více zařízení, vícefaktorové funkce. Obohacení zkušeností prostřednictvím studií použitelnosti.
Důležité informace
Komponenty v tomto scénáři řeší problémy s výkonem, spolehlivostí a zabezpečením.
API Management podporuje automatické škálování, které rychle rozšiřuje možnosti služby API Management v reakci na rostoucí počet příchozích požadavků. API Management také podporuje zónovou redundanci a nasazení ve více oblastech, aby byla zajištěna odolnost a vysoká dostupnost. Další informace o redundanci zón najdete v tématu Podpora zón dostupnosti pro Azure API Management. Další informace o zabezpečení služby API Management najdete v tématu Standardní hodnoty zabezpečení azure pro službu API Management.
App Service je plně spravovaná platforma jako služba, která nabízí integrované zabezpečení a automatické škálování se smlouvou SLA , která slibuje vysokou dostupnost. App Service je kompatibilní se standardem ISO, SOC a PCI a podporuje ověřování uživatelů s účtem Microsoft Entra ID, Google, Facebook, Twitter nebo Microsoft. Pomocí služby App Service můžete také vytvořit omezení IP adres.
Azure AD B2C nabízí vysokou dostupnost a škálování na podporu stovek milionů uživatelů. Azure AD B2C podporuje OpenID Připojení a více zprostředkovatelů identity, aby si zákazníci mohli vybrat preferovaného zprostředkovatele. Azure AD B2C také podporuje vícefaktorové ověřování založené na aplikacích a zásadách a přidává další vrstvy zabezpečení. Další informace o Azure AD B2C najdete v tématu Co je Azure Active Directory B2C? Další informace o používání externích identit naleznete v tématu Externí identity v Microsoft Entra ID.
GitHub provádí kontroly zabezpečení jako automatizovanou část kontrol kódu a kontroluje potenciální problémy se zabezpečením při každém novém potvrzení. Tato služba vám pomůže zjistit problémy hned, jak jsou nabízeny jako doplňky základu kódu. Zabezpečení GitHubu umožňuje přizpůsobit vyhledávání bezpečnostních aspektů a integrovat skenovací moduly třetích stran. Další funkce a podrobnosti najdete v tématu Zabezpečení na GitHubu.
Optimalizace nákladů
Uživatelský portál můžete vyvíjet pomocí cenového plánu Team nebo Enterprisepro GitHub. Informace o tom, který plán nejlépe vyhovuje vašemu podniku, najdete v matici funkcí.
Pro API Management můžete použít úrovně Standard nebo Premium . Pokud chcete lépe porozumět rozdílům mezi úrovněmi, přečtěte si informace o cenových možnostech služby API Management.
Informace o službě Aplikace Azure najdete v cenových možnostech dostupných pro prostředí s Windows a Linuxem pro hostování vašich aplikací.
Přispěvatelé
Tento článek spravuje Microsoft. Původně byla napsána následujícími přispěvateli.
Hlavní autor:
- Subhajit Chatterjee | Hlavní softwarový inženýr, oborové cloudy
Další kroky
- Monetizace pomocí služby Azure API Management
- Přehled portálu pro vývojáře ve službě Azure API Management
- Samoobslužné hostování portálu pro vývojáře služby API Management
- Brána v místním prostředí
- Začínáme se stránkami GitHubu