Kartlägg verktygen

Det lönar sig att allra först kartlägga och välja verktygen för API-hanteringen. Med hjälp av verktygen fortskrider det faktiska arbetet i anslutning till programmeringsgränssnitten snabbt och onödigt arbete undviks.

De viktigaste verktygen är

• Utvecklarportalen
• API Gateway
• API Manager
• API-analys.

Välj hanteringsverktyget utifrån följande kriterier:

1. Kostnader och användarvänlighet: Molnbaserade lösningar är ofta kostnadseffektiva och enkla att driftsätta.
2. Täcker basbehoven: Säkerställ att verktyget stöder alla centrala funktioner i API-hanteringen (t.ex. hantering av användarrättigheter, kontroll av fullmakter och övervakning av användningen).
3. Kompatibilitet: Verktyget ska fungera sömlöst ihop med organisationens nuvarande infrastruktur.
4. Kontinuitet: Säkerställ att det finns permanent finansiering för verktygen för API-hantering, som inte är beroende av enskilda projekt.

Hanteringsverktyg levereras av

• allmänt använda molntjänstleverantörer
• separata systemleverantörer
• projekt med öppen källkod.

Lösningarnas basfunktioner kan lätt jämföras med varandra.

I praktiken är det ofta viktigare att lösningen fungerar tillsammans med organisationens övriga infrastruktur än vilka skillnader det finns mellan enskilda lösningars hanteringsegenskaper.

API-utvecklarportalen är en webbplats där programutvecklarna kommer åt och testar programmeringsgränssnitten och begär användarrätt till dem.

Utvecklarportalen är en plats där organisationens alla programmeringsgränssnitt finns listade och där man kommer åt dem.

Här finns en uppdaterad beskrivning i två format:

1. i läsbar form
2. i ett format som kan utnyttjas automatiskt i utvecklarnas verktyg.

Med hjälp av utvecklarportalen kan organisationens programmeringsgränssnitt dokumenteras tillräckligt enhetligt. I bästa fall bidrar den med en struktur för innehållsproduktionen, så att beskrivningarna av programmeringsgränssnitten blir enhetliga när strukturen följs. Då är det lätt för en utomstående eller en ny person att förstå deras funktion och mervärdet som de ger.

Utvecklarportalen kan också innehålla

• färdiga referensgenomföranden som visar hur programmeringsgränssnittet används
• analysdata om programmeringsgränssnittens funktion
• störningsmeddelanden
• information om versionering av och livscykeln för programmeringsgränssnitt
• kontaktuppgifter till personer som kan hjälpa med driftsättning eller felanmälan.

En organisation inom den offentliga sektorn hanterar vanligtvis tiotals eller hundratals programmeringsgränssnitt. I samtliga behövs i regel samma basfunktioner:

• hantering av användarrättigheter
• övervakning av användningen
• begränsningar och prioriteringar som gäller användningen.

Att göra dessa grundläggande saker på nytt för varje programmeringsgränssnitt är bortkastat arbete.

API Gateway, alltså den centraliserade publikationskanalen, är ett program som sköter

• hanteringen av användarrättigheter och fullmakter för programmeringsgränssnitt
• verkställandet av informationssäkerhetspolitiken
• hanteringen och prioriteringen av datakommunikationen
• begränsningen och hanteringen av den totala belastningen på de bakomliggande informationssystemen
• användningen av cacheminne.

Alla molntjänstleverantörer har sina egna produkter och det finns också produkter med öppen källkod.

API Gateway är också en effektiv planeringsprincip och arkitekturmodell. Den är en central kontaktpunkt som döljer komplexiteten och centraliserar begränsningarna för verifieringen, uppföljningen av användningen och datakommunikationen. Läs mer: Charest, G. 2020.Öppnas i ett nytt fönster. API Principles and Practices Use of the API Gateway and Portal.Öppnas i ett nytt fönster. Harvard University (på engelska)Öppnas i ett nytt fönster..

Användningen av programmeringsgränssnitt skapar snabbt miljontals rader loggdata. Det är ofta arbetsamt att dra slutsatser om helhetsbilden baserat på dessa. Därför behövs programvara som producerar analyser av logganteckningarna och visualiserar informationen så att den är lättare att förstå för människan.

Analyser som omvandlar logginformation till observationer är en näst intill oumbärlig del i hanteringen av programmeringsgränssnitten som helhet.

Analyserna hjälper alla parter att utreda olika felsituationer. Dessutom möjliggör de kunskapsbaserat beslutsfattande i frågor kring programmeringsgränssnitt. Det lönar sig att förädla informationen så att den kan användas inom utveckling, affärsverksamhet, kundförvaltning och informationssäkerhet. Programmeringsgränssnittets loggar kan till exempel fungera som en av informationskällorna för ett säkerhetskontrollrum (Security Operation Center, SOC) som tar fram en helhetsbild.

API-analysens uppgift är att bokföra vilka programmeringsgränssnitt varje användare har använt, hur och när. När det gäller fritt tillgänglig information riktas intresset mot användningen av informationen som helhet och fördelningen i användningen. I fråga om information med begränsade åtkomsträttigheter är också kontroll av användningen i oklara situationer viktigt, i vissa användningsfall till och med på enskilda innehålls och användarnamns noggrannhet.

Hanteringsfunktionen, alltså API Manager, är avsedd för dem som opererar programmeringsgränssnitten.

I informationssystemet definieras

• vilka programmeringsgränssnitt som används
• vilka bakomliggande informationssystem de anropar
• programmeringsgränssnittsprotokoll
• identifieringssätt
• användarrättigheter.

De specifikationer som gjorts i hanteringsfunktionen överförs till API Gateway, som genomför de önskade funktionerna i praktiken.

I hanteringsverktyget kan det också ingå en webbläsarbaserad eller separat applikation som gör det lättare att specificera programmeringsgränssnitten. Slutresultatet av specifikationsverktyget är ett antal gränssnittsspecifikationer som de andra avsnitten i hanteringssystemet använder.

Organisationens hanteringen av interna programmeringsgränssnitt kan avvika från de externa programmeringsgränssnitten.

Allmänt används något av de följande tre alternativen för hanteringen av interna programmeringsgränssnitt:

1. Ingen separat hantering: Om den tekniska dokumentationen är lätt tillgänglig och antalet användare av programmeringsgränssnitten är litet, kan separat hantering vara onödig. Bruksanvisningarna kan ingå i den övriga dokumentationen som utvecklings- och underhållsteamen använder. Denna modell kan lämpa sig särskilt för små och avgränsade miljöer.
2. Samma hanteringslösning som för de externa programmeringsgränssnitten: Om det finns många interna utvecklarteam eller om man vill dra nytta av systematik kan interna programmeringsgränssnitt hanteras på samma sätt som externa. Då rekommenderas att API Gateway är placerad i samma datacenter eller molntjänst som organisationens övriga tjänster för att minimera konsekvenserna av störningar i datakommunikationen.
3. Service mesh-modellen: I den här modellen skapas ett separat system och en utvecklarportal för hanteringen av interna programmeringsgränssnitt, på samma sätt som i alternativ två, men datakommunikationsförbindelserna bildas direkt från det anropande informationssystemet till det informationssystem som tillhandahåller programmeringsgränssnittet. Detta kombinerar kontrollerbarhet och effektivitet, men kan innebära mer lärande inledningsvis.