Dela via

Så här stöder API Management intäktsgenerering

  • Artikel

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

Med Azure API Management-tjänstplattformen kan du:

  • Publicera API:er som dina konsumenter prenumererar på.
  • Avriskimplementering.
  • Påskynda projektets tidsskalor.
  • Skala dina API:er med tillförsikt.

I det här dokumentet fokuserar vi på API Management-funktioner som möjliggör implementering av din intäktsstrategi, som att tillhandahålla en friktionsfri upplevelse för att:

  • Identifiera dina offentliga API:er.
  • Ange betalningsinformation.
  • Aktivera din prenumeration.
  • Använd API:et.
  • Övervaka användning.
  • Betala automatiskt för användning av API:et.

Diagrammet nedan beskriver följande viktiga API Management-funktioner:

Diagram över nyckelfunktionerna för API Management-intäktsgenerering

API-identifiering

Starta ditt API och registrera API-konsumenter med hjälp av API Managements inbyggda utvecklarportal. Betona utvecklingsinnehåll av god kvalitet för utvecklarportalen, så att API-konsumenter kan utforska och använda dina API:er sömlöst. Testa innehållet och informationen som tillhandahålls för tillgänglighet, noggrannhet och användbarhet.

Mer information om hur du lägger till innehåll och styr varumärkesanpassningen för utvecklarportalen finns i översikten över utvecklarportalen.

API-paketering

API Management hanterar hur dina API:er paketeras och presenteras med hjälp av begreppet produkter och principer.

Produkter

API:er publiceras via produkter. Med produkter kan du definiera:

  • Vilka API:er en prenumerant kan komma åt.
  • Specifika begränsningsprinciper, till exempel att begränsa en specifik prenumeration till en kvot för anrop per månad.

När en API-konsument prenumererar på en produkt får de en API-nyckel som de gör anrop med. Till en början är prenumerationen inställd på ett submitted tillstånd. Aktivera prenumerationen så att prenumeranter kan använda API:erna.

Konfigurera API Management-produkterna för att paketera ditt underliggande API för att spegla intäktsmodellen med:

  • En en-till-en-relation mellan varje nivå i intäktsmodellen.
  • En motsvarande API Management-produkt.

Exempelprojekt använder API Management-produkter som det översta sättet att koda intäktsgenereringsstrategin. API Management-produkterna speglar intäktsmodellnivåerna och indexar den specifika prismodellen för varje nivå. Den här konfigurationen ger en flexibel, konfigurationsdriven metod för att förbereda intäktsgenereringsstrategin.

Principer

Använd API Management-principer för att kontrollera tjänstkvaliteten för varje produkt. Exempelprojekt använder två specifika principfunktioner för att kontrollera tjänstens kvalitet, i linje med intäktsmodellen:

Principfunktion beskrivning
Kvot Definierar det totala antalet anrop som användaren kan göra till API:et under en angiven tidsperiod. Till exempel "100 anrop per månad". När användaren når kvoten misslyckas anropen till API:et och anroparen får en 403 Forbidden svarsstatuskod.
Hastighetsgräns Definierar antalet anrop över ett glidande tidsfönster som kan göras till API:et. Till exempel "200 anrop per minut". Utformad för att förhindra toppar i API-användningen utöver den betalda tjänstkvaliteten med den valda produkten. När samtalsfrekvensen överskrids får anroparen en 429 Too Many Requests svarsstatuskod.

Mer information om principer finns i dokumentationen om principer i Azure API Management .

API-förbrukning

Bevilja åtkomst för API-konsumenter till dina API:er via produkter som använder API-prenumerationer.

  1. API-konsumenter upprättar API-prenumerationer när de registrerar sig för en specifik API Management-produkt.
  2. Integrera prenumerationsprocessen med betalningsleverantören med hjälp av API Management-delegering.
  3. När betalningsinformationen har angetts får användarna åtkomst till API:et med en genererad, unik säkerhetsnyckel för prenumerationen.

Mer information om prenumerationer finns i dokumentationen prenumerationer i Azure API Management .

API-användningsövervakning

Få insikter om din API-användning och prestanda med hjälp av API Managements inbyggda analys. Dessa analyser tillhandahåller rapporter genom att:

  • API
  • Geografi
  • API-åtgärder
  • Produkt
  • Förfrågan
  • Prenumeration
  • Tid
  • User

Granska analysrapporterna regelbundet för att förstå hur din strategi för intäktsgenerering antas av API-konsumenter.

Mer information finns i Hämta API-analys i Azure API Management.

Säkerhet

Kontrollera åtkomstnivån för varje användare till varje produkt med hjälp av API Managements produkter, API-principer och prenumerationer. Förhindra missbruk och missbruk genom att bevilja API-åtkomst på prenumerationsnivå om användaren har autentiserats med betalningsleverantören, även om den specifika API-produkten är kostnadsfri.

Integrering

Skapa en smidig intäktsgenereringsupplevelse genom både klientdels- och serverdelsintegrering mellan API Management och din valda betalningsleverantör. Använd API Management-delegering för klientdelsintegrering och REST API för serverdelsintegrering.

Delegering

I exempelprojekten kan du använda API Management-delegering för att göra anpassade integreringar med betalningsleverantörer från tredje part. Demonstrationen använder delegering för både registrerings-/inloggnings- och produktprenumerationsupplevelser.

Arbetsflöde för registrering/inloggning

  1. Utvecklaren klickar på inloggnings- eller registreringslänken på API Management-utvecklarportalen.
  2. Webbläsaren omdirigerar till delegeringsslutpunkten (konfigurerad till en sida i den anpassade faktureringsportalappen).
  3. En anpassad faktureringsportalapp visar ett användargränssnitt för inloggning/registrering.
  4. Vid lyckad inloggning/registrering autentiseras användaren och omdirigeras tillbaka till startsidan för API Management-utvecklarportalen.

Arbetsflöde för produktprenumeration

  1. Utvecklare väljer en produkt i API Management-utvecklarportalen och klickar på knappen Prenumerera
  2. Webbläsaren omdirigerar till delegeringsslutpunkten (konfigurerad till en sida i den anpassade faktureringsportalappen).
  3. Anpassad faktureringsportalapp:
    • Visar ett användargränssnitt som konfigurerats baserat på betalningsleverantören (Stripe eller Adyen).
    • Tar användaren genom den relevanta utcheckningsprocessen.
  4. Användaren omdirigeras tillbaka till startsidan för API Management-produkten.
    • Produkten kommer att vara aktiv och API-nycklarna kommer att vara tillgängliga.

REST-API

Använd REST API för API Management för att automatisera driften av din intäktsstrategi.

Exempelprojekten använder API:et för att programmatiskt:

  • Hämta API Management-produkter och principer för att aktivera synkroniserad konfiguration av liknande begrepp i betalningsleverantörer, till exempel Stripe.
  • Avsök API Management regelbundet för att hämta API-användningsstatistik för varje prenumeration och driva faktureringsprocessen.

Mer information finns i översikten över REST API Azure API Management .

DevOps

Versionskontroll och automatisera distributionsändringar i API Management med Hjälp av Azure Resource Manager, inklusive konfiguration av funktioner som implementerar din strategi för intäktsgenerering, till exempel:

  • Produkter
  • Principer
  • Utvecklarportalen

I exempelprojekt utökas Azure Resource Manager-skripten med en JSON-fil som definierar prismodellen för varje API Management-produkt. Med den här förstoringen kan du synkronisera konfigurationen mellan API Management och den valda betalningsleverantören. Hela lösningen hanteras under en lagringsplats för en enda källkontroll för att:

  • Samordna alla ändringar som är associerade med den pågående utvecklingen av intäktsgenereringsstrategin som en enda version.
  • Utför ändringarna enligt styrnings- och granskningskraven.

Initiering och distribution

API Management kan distribueras antingen via:

Videoklipp

Integrera API Management med Adyen-betalningsgateway

Integrera API Management med Stripe-betalningsgateway

Nästa steg