WoordenlijstAPI
Een API definieert een gestructureerde manier om gegevens uit te wisselen of een bewerking aan te vragen tussen systemen. In een programma kan het aankopen, geschiktheid, punten of bestellingen koppelen. Het contract, de authenticatie, fouten, limieten en herstelwerkzaamheden moeten worden gedocumenteerd om de integratie bruikbaar te maken.
Een concreet voorbeeld
Een API kan een gevalideerde bestelling ontvangen en de bijbehorende verwerkings-ID retourneren. Een unieke ID voorkomt dat dezelfde transactie tweemaal wordt gecrediteerd.
Een punt om te overwegen
Het is onvoldoende om alleen het nominale geval te behandelen. Documenteer authenticatie, duplicaten, fouten, herhaalpogingen en frequentielimieten.
Stel een contract op dat door beide teams kan worden gebruikt
Geef voor elke uitwisseling een geaccepteerd voorbeeld, een afgewezen voorbeeld, de verplichte velden en de hervattingsregels. Definieer een correlatie-identificatie om een transactie tussen systemen te traceren. Test een onderbreking na de verwerking, maar vóór het ontvangen van het antwoord: de hervatting moet het resultaat ophalen zonder een tweede credit aan te maken. Plan ook voor het bijhouden van afwijzingen en het waarborgen van versiecompatibiliteit.
Vragen om aan je team te stellen
- Kunnen we vaststellen of een transactie na een storing is verwerkt?
- Worden tijdelijke fouten en ongeldige gegevens anders behandeld?
Bouw je netwerk uit.
Whitepapers