Aanbevelingen voor API's in het ontwerp van een dienst

Uit NORA Online
Ga naar: navigatie, zoeken
Wordcloud met woorden rond API, zoals developers, use en many. Overgenomen van [https://commons.wikimedia.org/wiki/File:Apisssss.gif wikimedia commons
→ Terug naar voorpagina API

Hoe kan je API’s gebruiken bij het (her)ontwerp van een specifieke dienst?

Hieronder geven we handvatten voor een Business c.q. Solution Architect, die de architectuurEen beschrijving van een complex geheel, en van de principes die van toepassing zijn op de ontwikkeling van het geheel en zijn onderdelen. van een dienst gaat beschrijven:

  1. Ga bij de Enterprise Architect van jouw organisatie na of de organisatie afdoende is ingericht op het gebruik van API’s. Zie ook Aanbevelingen voor API's in de Enterprise Architectuur Als dat namelijk niet zo is, dan zal dat eerst geregeld moeten worden of kan het gebruik van API’s wellicht beter nog niet in het ontwerp van de dienst worden opgenomen.
  2. Ga na welke AP's van belang zijn bij API's.
  3. Zorg er voor dat een goede beschrijving van de dienst beschikbaar is (zie AP5), in de zin dat duidelijk is:
    1. wat het resultaat voor de burger is;
    2. met welke processen die dienst wordt geleverd;
    3. welke (business)functies daartoe nodig zijn;
  4. Zorg voor duidelijkheid over welke gegevens daartoe nodig zijn: de informatie-objecten en hun onderlinge relaties (zie AP17);
  5. Zorg voor duidelijkheid over de bron-registratie waaruit elk van deze gegevens zal worden afgenomen (zie AP13);
  6. Vind de juiste (voorbeeld-)API voor jou op basis van Bedrijfsfuncties (Processen), Gegevens of Registraties: <dit onderdeel is nog in onderzoek, als je hier ideeën voor hebt, neem dan even contact op met nora@ictu.nl>. Voorlopig zal je het dus nog moeten doen met onderstaande handvatten:
  7. Ga na hoe de (business)functies het beste kunnen worden ingevuld (handmatig of geautomatiseerd). Denk daarbij eerst vanuit hergebruik: Standaard oplossingen (AP6) of Landelijke bouwstenen (AP7), waaronder ook API’s; NB. De aangegeven AP’s omvatten handvatten voor het hergebruik en verwijzen onder meer naar vindplaatsen van API’s, zoals DON, maar ook API library, een internationale directory van ca. 22.000 bedrijfs-API’s.
  8. Als hergebruik niet mogelijk is, kijk dan naar de optie voor “maatwerk” om 1 of meer API’s te ontwerpen waarmee de dienst kan worden gerealiseerd en volg de ontwerp richtlijnen (API-Designrules).