ABB: API Gateway

Dienstbeschrijving

API Gateway Dienst

Als onderdeel van RWS infrastructuur biedt het Integratie Platform met de API Gateway Dienst een centraal beheerde oplossing voor het ontsluiten van API’s binnen Rijkswaterstaat. Deze dienst stelt afdelingen in staat om hun API’s op een veilige, gestandaardiseerde en schaalbare manier beschikbaar te stellen aan interne en externe gebruikers.

Het Integratie Platform biedt met deze dienst:

• Beveiligde toegang: Authenticatie, autorisatie en rate limiting zijn standaard inbegrepen.
• Monitoring & Logging: Inzicht in gebruik, performance en foutmeldingen via dashboards en alerts.
• Versiebeheer & Lifecycle Management: Ondersteuning voor versiebeheer en gecontroleerde uitfasering.
• Schaalbaarheid: Automatische load balancing en ondersteuning voor hoge beschikbaarheid.
• Compliance & Governance: Voldoen aan interne richtlijnen en externe regelgeving.
• Support & Advies: Technische ondersteuning en architectuuradvies bij onboarding van je API.

Kostenmodel
Om de continuïteit en kwaliteit van deze dienst te waarborgen, hanteren we een pay-per-API model. Dit betekent dat per ontsloten API een vast bedrag wordt gerekend, waarmee we de infrastructuur, support en doorontwikkeling financieren.

Functionele Specificaties

1. Verkeerbeheer & Routing

• Request routing: Verdeling van inkomende API-verzoeken naar de juiste backend services.
• Load balancing: Verdeling van verkeer over meerdere instanties van een service.
• Protocol transformatie: Ondersteuning voor verschillende protocollen (HTTP, WebSocket, gRPC, etc.).

2. Beveiliging

• Authenticatie: Ondersteuning voor OAuth2, JWT, API keys, etc.
• Autorisatie: Beperking van toegang op basis van rollen of policies.
• Rate limiting & throttling: Beperking van het aantal verzoeken per tijdseenheid.
• IP whitelisting/blacklisting: Toegang beperken op basis van IP-adressen.
• TLS termination: Versleuteling van verkeer via HTTPS.

3. Monitoring & Logging

• Request/response logging: Gedetailleerde logs van API-verkeer.
• Metrics & analytics: Inzicht in gebruik, performance, foutpercentages, etc.
• Tracing: Integratie met distributed tracing tools (zoals OpenTelemetry).

4. Transformatie & Validatie

• Request/response transformatie: Aanpassing van payloads (bijv. JSON naar XML).
• Schema validatie: Validatie van inkomende verzoeken tegen een schema (bijv. OpenAPI).
• Header manipulatie: Toevoegen, verwijderen of aanpassen van HTTP headers.

5. Developer Experience

• API catalogus/publicatie: Documentatie en publicatie van beschikbare API’s.
• Self-service portal: Voor ontwikkelaars om API keys aan te vragen, documentatie te bekijken, etc.
• Mocking & sandboxing: Testmogelijkheden zonder echte backend.

6. Beheer & Governance

• Policy management: Beheer van regels voor toegang, beveiliging en routing.
• Versionering: Ondersteuning voor meerdere versies van een API.
• Multi-tenancy: Scheiding van API’s per team, klant of omgeving.

Roadmaps

https://samenwerken.sp01.intranet.rws.nl/sites/vpr0000641/SitePages/Roadmap-Integratie.aspx 

Landingslocaties

RWS Datacenter 1.5 DMZ.

Beschikbare SBBs 

In afwachting op definitief besluit over de volgende opties:

a. Tyk gateway

b. APISIX Apache gateway

Koppelvlakken

Interfaces en afhankelijkheden tussen verschillende architectuurelementen. Dit zijn bijvoorbeeld de protocollen die kunnen worden gebruikt door andere bouwblokken die gebruik maken van het ABB.

Afhankelijkheden

Beschrijving waar dit ABB van afhankelijk is of welke ABBs afhankelijk zijn van het ABB. Dit geldt ook voor de verschillende serviceketens. Geef dit aan met links naar de architectuur elementen.

EIRA Koppeling

Dit bouwblok is gekoppeld binnen de EIRA aan: Gateway, API Gateway, Solution Building Block, PaaS

Een overzicht van alle relevante EIRA bouwblokken staan hier: EIRA Technology & Physical