API Capability Model
Als organisatie beschikken over de benodigde bekwaamheden vereist maatregelen die zowel de bedrijfs-, informatie- als technische architectuur raken. Op organisatorisch gebied moet bijvoorbeeld zijn geregeld dat taken en verantwoordelijkheden rondom aanbieden en gebruik van API's goed zijn belegd. Binnen de informatievoorziening moeten voorzieningen API's kennen die verantwoord zijn te gebruiken. Tot slot moeten technologische voorzieningen het mogelijk maken om snel en veilig toegang tot API's te krijgen.
Binnen de Nederlandse API Strategie is een 'API Capability Model' ontwikkeld dat beschrijft aan welke onderwerpen men aandacht moet schenken bij het werken met API's. Het model bevat generieke functies, of capability's, waarover een organisatie moet beschikken om verantwoord en effectief API's aan te bieden en gebruiken. Daarbij geldt dat generieke functies beschrijven wat er nodig is. Niet hoe en functie moet worden gerealiseerd.
Binnen het model zijn generieke functies gegroepeerd in 3 categorieën:
- Registratie & gebruik: functies voor het ondersteunen van ontwikkelaars die gebruik willen maken van de aangeboden API's.
- Realisatie & beheer: functies voor het (door)ontwikkelen van API's, het beheren van API lifecycles en het beheren van het API ecosysteem.
- Verkeersstroom beheer: functies die te maken hebben met verwerken van daadwerkelijk verkeer tussen de API client en aanbieder en het verwerken daarvan binnen het API landschap.
Onderstaande tabel toont per categorie de onderscheiden generieke functies.
| Registratie & Gebruik | Realisatie & Beheer | Verkeersstroom beheer |
| Ontwikkelaar onboarding | Ontwerp | Mediatie & Orkestratie |
| Applicatie registratie | Ontwikkeling | Routering |
| API Discovery | Test | Data Transformaties |
| Specificatie & Documentatie | Policy Definitie | Foutafhandeling |
| Proeftuin / Sandbox | Afspraken, Standaarden en Richtlijnen | Caching |
| Code voorbeelden & SDK | Governance policy handhaving | Protocol conversie |
| Kennisdeling & Ondersteuning | API Lifecycle beheer | Logging & Audit trail |
| Versionering | Monitoring & Alerting | |
| Toegangsbeheer | Analytics & Dashboarding | |
| Gateway beheer | 0Rate limiting / throttling | |
| Sleutelbeheer | Doorbelasting | |
| Identificatie & Authenticatie | ||
| Autorisatie | ||
| Policy handhaving | ||
| Anomalie detectie |
Het model laat zien dat er veel verschillende soorten functies zijn die van belang (kunnen) zijn bij het werken met API's. Uiteraard geldt dat niet iedere functie voor iedere organisatie relevant is. Een organisatie die geen API's aanbiedt, maar alleen API's afneemt hoeft een aantal functies niet te realiseren. Maar in alle gevallen blijft het belangrijk om om te beseffen dat toenemend gebruik van API's het noodzakelijk maakt om als organisatie aandacht te besteden aan hier genoemde onderwerpen.
Een beschrijving van het API Capabilty Model en van de daarin opgenomen generieke functies is te vinden in de module 'Architectuur' van de NL API Strategie.