Intro API guidelines
Introductie
Bijna elk business proces wordt ondersteund door API's die informatie versluizen van het ene informatiesysteem naar het andere. Naast semantische interoperabiliteit van de data die uitgewisseld worden, is het belangrijk om te weten hoe deze API's kunnen bevraagd worden, welke functionaliteit ze bieden en hoe we ermee kunnen koppelen. De in 2018 ontwikkelde Hypermedia API (richtinggevend voor machines) biedt reeds een aantal gestandaardiseerde bouwblokken aan om integratie met API’s automatisch te laten verlopen, opdat een machine door een API kan browsen zoals wij mensen de hyperlinks volgen op webpagina's.
Probleemstelling
- As-is situatie: data semantisch geannoteerd met behulp van web standaarden, maar geen standaard methoden en operaties voor ontsluiting via en koppelingen tussen API’s.
- Probleem: nog steeds (hoge) integratiekosten en “koppelingen op maat” om gegevens uit te wisselen in-real-time.
- To-be situatie: standaardisatie van veelgebruikte methoden met Hypermedia en API richtlijnen.
Ambitie
- Ontwikkelen van een vrijwillig toe te passen standaard
- Regels die een ‘generieke client’ definiëren aan de hand van regels en best practices.
- API’s die deze regels toepassen zijn technisch interoperabel.
De bouwblokken van een API
Een API bevat meerdere bouwblokken die op een verschillende manier kunnen worden geïmplementeerd naargelang de toepassing. Voorbeelden van zo'n bouwblokken zijn:
- Paginering
- Full text search
- Versionering van data
- Taal-ontdekking
- CRUD operaties
- Authenticatie
Enkele van de bouwblokken van de Generieke Hypermedia API worden hier verder besproken.