Notitie
Voor toegang tot deze pagina is autorisatie vereist. U kunt proberen u aan te melden of de directory te wijzigen.
Voor toegang tot deze pagina is autorisatie vereist. U kunt proberen de mappen te wijzigen.
Van toepassing op: Alle API Management-lagen
Met het Azure API Management-serviceplatform kunt u het volgende doen:
- Publiceer API's waarop uw consumenten zich abonneren.
- Risico's tijdens de implementatie verminderen.
- Versnel projecttermijnen.
- Schaal uw API's met vertrouwen.
In dit document richten we ons op API Management-functies die de implementatie van uw strategie voor inkomsten genereren mogelijk maken, zoals het bieden van een probleemloze ervaring aan:
- Ontdek uw openbare API's.
- Voer betalingsgegevens in.
- Activeer een abonnement.
- De API gebruiken.
- Gebruik bewaken.
- Automatisch betalen voor het gebruik van de API.
In het volgende diagram worden de volgende belangrijke API Management-functies geïntroduceerd:
API-detectie
Start uw API en onboard API-consumenten met behulp van de ingebouwde ontwikkelaarsportal van API Management. Benadruk de ontwikkelinhoud van goede kwaliteit voor de ontwikkelaarsportal, zodat API-gebruikers uw API's naadloos kunnen verkennen en gebruiken. Test de inhoud en informatie die beschikbaar is voor toegankelijkheid, grondigheid en bruikbaarheid.
Zie Overzicht van de ontwikkelaarsportal voor meer informatie over het toevoegen van inhoud en het beheren van de huisstijl van de ontwikkelaarsportal.
API-pakketten
Met API Management kunt u beheren hoe uw API's worden verpakt en gepresenteerd met behulp van het concept van producten en beleidsregels.
Producten
API's worden gepubliceerd via producten. Met producten kunt u het volgende definiëren:
- Welke API's een abonnee kan openen.
- Specifiek beperkingsbeleid, zoals het beperken van een specifiek abonnement tot een quotum van aanroepen per maand.
Wanneer een API-consument zich abonneert op een product, ontvangen ze een API-sleutel die ze kunnen gebruiken om aanroepen te doen. In eerste instantie is het abonnement ingesteld op een submitted status. Activeer het abonnement zodat abonnees de API's kunnen gebruiken.
U kunt de API Management-producten configureren om uw onderliggende API te verpakken om uw omzetmodel te spiegelen, met:
- Een een-op-een-relatie tussen elke laag in uw omzetmodel.
- Een bijbehorend API Management-product.
Voorbeeldprojecten maken gebruik van API Management-producten als de middelen op het hoogste niveau om de strategie voor het genereren van inkomsten te codificeren. De API Management-producten weerspiegelen de lagen van het omzetmodel en indexeren het specifieke prijsmodel voor elke laag. Deze instelling biedt een flexibele, configuratiegestuurde benadering voor het voorbereiden van de strategie voor het genereren van inkomsten.
Beleid
Pas API Management-beleid toe om de kwaliteit van de service voor elk product te beheren. Voorbeeldprojecten gebruiken twee specifieke beleidsfuncties om de kwaliteit van de service te beheren, in overeenstemming met het omzetmodel:
| Beleidseigenschap | Beschrijving |
|---|---|
| Quotum | Hiermee definieert u het totale aantal aanroepen dat de gebruiker gedurende een opgegeven periode naar de API kan doen, bijvoorbeeld 100 aanroepen per maand. Zodra de gebruiker het quotum heeft bereikt, mislukken de aanroepen naar de API en ontvangt de aanroeper een 403 Forbidden antwoordstatuscode. |
| Frequentielimiet | Hiermee definieert u het aantal aanroepen via een tijdvenster dat naar de API kan worden verzonden, bijvoorbeeld 200 aanroepen per minuut. Ontworpen om pieken in API-gebruik te voorkomen buiten de betaalde kwaliteit van de service met het gekozen product. Wanneer de oproepsnelheid wordt overschreden, ontvangt de beller een 429 Too Many Requests antwoordstatuscode. |
Zie Beleid in Azure API Management voor meer informatie over beleidsregels.
API-verbruik
Ververleent toegang voor API-consumenten aan uw API's via producten met behulp van API-abonnementen.
- API-gebruikers stellen API-abonnementen vast wanneer ze zich registreren voor een specifiek API Management-product.
- Integreer het abonnementsproces met de betalingsprovider met behulp van API Management-delegatie.
- Nadat ze betalingsgegevens hebben opgegeven, krijgen gebruikers toegang tot de API met een gegenereerde, unieke beveiligingssleutel voor het abonnement.
Zie Abonnementen in Azure API Management voor meer informatie over abonnementen.
Bewaking van API-gebruik
U kunt inzicht krijgen in uw API-gebruik en -prestaties met behulp van de ingebouwde analyses van API Management. Deze analyses leveren rapporten op via:
- API (Application Programming Interface)
- Geografie
- API-bewerkingen
- Product
- Aanvraag
- Abonnement
- Tijd
- Gebruiker
Bekijk regelmatig de analyserapporten om te begrijpen hoe uw strategie voor het genereren van inkomsten wordt gebruikt door API-consumenten.
Zie voor meer informatie API Management Monitoren.
Veiligheid
Beheer het toegangsniveau voor elke gebruiker voor elk product met behulp van API Management-producten, API-beleid en abonnementen. Voorkom misbruik en misbruik door API-toegang op abonnementsniveau te verlenen als de gebruiker is geverifieerd bij de betalingsprovider, zelfs als het specifieke API-product gratis is.
Integratie
Maak een naadloze ervaring voor het genereren van inkomsten via zowel front-end- als back-endintegratie tussen API Management en de door u gekozen betalingsprovider. Gebruik API Management-delegatie voor front-endintegratie en de REST API voor back-endintegratie.
Delegatie
In de voorbeeldprojecten kunt u API Management-delegatie gebruiken om aangepaste integraties te maken met de partnerbetalingsproviders. De demo maakt gebruik van delegering voor zowel de ervaringen voor registreren/aanmelden als het productabonnement.
Werkstroom voor registreren/aanmelden
- De ontwikkelaar selecteert de aanmeldings- of registratiekoppeling in de API Management-ontwikkelaarsportal.
- De webbrowser wordt omgeleid naar het delegeringseindpunt (geconfigureerd voor een pagina in de aangepaste factureringsportal-app).
- De aangepaste factureringsportal-app biedt een gebruikersinterface voor aanmelden/registreren.
- Na een geslaagde aanmelding/aanmelding wordt de gebruiker geverifieerd en teruggeleid naar de startpagina van de API Management-ontwikkelaarsportal.
Werkstroom voor productabonnementen
- De ontwikkelaar selecteert een product in de API Management-ontwikkelaarsportal en kiest de knop Abonneren .
- De webbrowser wordt omgeleid naar het delegeringseindpunt (geconfigureerd voor een pagina in de aangepaste factureringsportal-app).
- De aangepaste factureringsportal-app:
- Hiermee wordt een gebruikersinterface weergegeven die is geconfigureerd op basis van de betalingsprovider (Stripe of Adyen).
- Neemt de gebruiker mee door het relevante afrekenproces.
- De gebruiker wordt teruggeleid naar de productpagina van API Management.
- Het product is actief en de API-sleutels zijn beschikbaar.
REST-API
Gebruik de REST API voor API Management om de werking van uw strategie voor inkomsten te automatiseren.
De voorbeeldprojecten gebruiken de API om programmatisch te werken:
- Haal API Management-producten en -beleid op om gesynchroniseerde configuratie van vergelijkbare concepten in betalingsproviders mogelijk te maken, zoals Stripe.
- Poll API Management regelmatig om metrische gegevens over API-gebruik op te halen voor elk abonnement en het factureringsproces te stimuleren.
Voor meer informatie, zie Azure API Management REST API-naslaginformatie.
DevOps
Implementeer versiebeheer en automatiseer implementatiewijzigingen in API Management met behulp van Azure Resource Manager, waaronder het configureren van functies die uw strategie voor het genereren van inkomsten implementeren, zoals:
- Producten
- Beleid
- De ontwikkelaarsportal
In voorbeeldprojecten worden de Azure Resource Manager-scripts uitgebreid met een JSON-bestand, waarmee het prijsmodel van elk API Management-product wordt gedefinieerd. Met deze uitbreiding kunt u de configuratie tussen API Management en de gekozen betalingsprovider synchroniseren. De volledige oplossing wordt beheerd onder één opslagplaats voor broncodebeheer om:
- Coördineer alle wijzigingen die zijn gekoppeld aan de doorlopende ontwikkeling van de inkomstenstrategie als één release.
- Voer de wijzigingen uit, volg de governance- en controlevereisten.
Initialisatie en implementatie
API Management kan worden geïmplementeerd via:
- Het Azure-portal
- Een infrastructuur als codebenadering met behulp van Azure Resource Manager-sjablonen