ABB: API Register

Dienstbeschrijving

API Register Dienst

Met de API Register Dienst kan RWS de volgende features aanbieden die de ontwikkeling, integratie en het beheer van API’s en applicaties versnellen en vereenvoudigen.

Het Integratie Platform biedt met deze dienst:

• Herbruikbare API-specificaties: Ontwikkelaars kunnen REST- en GraphQL-API’s publiceren, testen en documenteren, inclusief mock-services en interactieve API Notebooks.
• Connectors en integratiecomponenten: Het API Register biedt kant-en-klare connectors voor populaire systemen zoals Salesforce, SAP en AWS, waarmee integraties snel kunnen worden opgezet zonder maatwerk.
• Templates en voorbeelden: Gebruikers kunnen integratietemplates en voorbeeldprojecten hergebruiken om sneller oplossingen te bouwen en best practices toe te passen.
• Beleidsregels en governance-assets: RWS kan beveiligings- en toegangsbeleid delen en hergebruiken, wat consistentie en compliance bevordert.
• Samenwerkings- en publicatiefuncties: Afdelingen kunnen assets beoordelen, delen binnen teams, en gebruiksstatistieken bekijken om samenwerking en adoptie te stimuleren.

Kostenmodel
Voor het gebruik van deze dienst worden geen kosten gerekend.

Functionele Specificaties

Assetbeheer en Publicatie

• Ondersteunde assettypes:
  • REST, SOAP, GraphQL en HTTP API-specificaties (RAML, OAS, WSDL)
  • API-groepen en spec-fragmenten
  • Connectors, templates, policies, voorbeelden, Mule-applicaties
• Publicatiefunctionaliteit:
  • Assets kunnen handmatig of via de bouwstraat worden gepubliceerd
  • Ondersteuning voor versiebeheer (asset version en API version)
  • Mogelijkheid om tags, categorieën en metadata toe te voegen 

Documentatie en Developer Experience

• Automatisch gegenereerde API-portals:
  • Inclusief interactieve console, mock service, en documentatie
  • Portals kunnen publiek of privé zijn
• Einstein generative AI: Genereert automatisch API-documentatie op basis van specificaties
• Markdown/HTML ondersteuning voor documentatiepagina’s

Zoekbaarheid en Herbruikbaarheid

• Geavanceerde zoekfunctionaliteit:
  • Filteren op type, tags, beschrijving, specificatie-inhoud
  • Ondersteuning voor custom velden en opgeslagen zoekopdrachten
  • REST Connect: Automatische connectorgeneratie voor gepubliceerde REST APIs
• Asset dependency mapping: API Register toont afhankelijkheden tussen assets

Samenwerking en Governance

• Rolgebaseerde toegang: Beheer wie assets mag bekijken, bewerken of publiceren
• Business group segmentatie: Assets zijn gegroepeerd per business unit
• Publieke portals: Organisaties kunnen assets delen via een gepersonaliseerde publieke portal

Testen en Validatie

• Mocking services: Simuleer API-calls voor validatie vóór implementatie
• API Notebooks: Beschrijf en test API-functionaliteit interactief

Roadmaps

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

Landingslocaties

De landingslocatie van de Mulesoft Control Plane bevindt zich in de SaaS oplossing van Mulesoft (onderdeel van Salesforce). Binnen Mulesoft is een afgesloten Rijkswaterstaat tenant aanwezig. De SaaS oplossing van Mulesoft bevindt zich in het Amazon Web Services datacenter te Frankfurt, Duitsland.

Beschikbare SBBs 

Mulesoft Exchange

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: Solution Building Block, Object-Oriented Database Manager

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