Wanneer software, databronnen of toestellen niet betrouwbaar gegevens uitwisselen, moeten medewerkers informatie opnieuw invoeren of handmatig doorgeven. Een API-koppeling kan die tussenstappen wegnemen. Daarvoor moeten ook data-eigenaarschap, beveiliging, foutafhandeling en beheer zorgvuldig zijn uitgewerkt.
Keysoft Solutions bouwt koppelingen op basis van uw dagelijkse werking en de interfaces die de betrokken systemen aanbieden.
twee toepassingen gegevens in beide richtingen moeten synchroniseren;
een extern platform gebeurtenissen via webhooks aanbiedt;
een legacytoepassing alleen bestanden, een database of een propriëtaire interface heeft;
medewerkers dezelfde informatie in meerdere systemen invoeren;
toestellen of gebouwen gegevens naar cloudsoftware moeten sturen;
een bestaande koppeling fragiel, ongedocumenteerd of moeilijk te monitoren is;
u een eigen API nodig hebt om gecontroleerd toegang te geven tot functies of gegevens.
We kiezen de technische aanpak op basis van de bron, het doel, de frequentie, de datakwaliteit en de gevolgen als er iets misgaat.
Eerst de werking, dan de koppeling
BronsysteemGegevens · eigenaar · timing
VerwerkingKoppelen · omzetten · valideren
DoelsysteemUitwisseling · verwerking
Bij uitval of ongeldige data: detectie en herstel
Ontwerp vóór ontwikkeling
Van integratievraag naar gegevensstroom
Voor we beginnen te ontwikkelen, brengen we minstens in kaart:
welke systemen en eigenaars betrokken zijn;
welke gegevens of gebeurtenissen worden uitgewisseld;
welke bron leidend is voor de gegevens;
hoe gegevensrecords en hun identificatiecodes aan elkaar worden gekoppeld;
welke gegevens moeten worden omgezet en welke controles nodig zijn;
hoe vaak de uitwisseling gebeurt, wanneer en in welke volgorde;
wat bij uitval of ongeldige data moet gebeuren;
wie de werking opvolgt na oplevering.
Een geslaagde API-aanroep is nog geen betrouwbare bedrijfsintegratie.
De beschikbare interface bepaalt de aanpak
API, webhook, database, bestand of maatwerkconnector
Toepassing
API
Toepassing
REST API’s
Waar een geschikte REST API beschikbaar is, kan Keysoft die gebruiken voor de gegevensuitwisseling. We kunnen ook een eigen API ontwerpen en hosten voor een afgebakende toepassing.
Gebeurtenis
Ontvanger
Webhooks
Een webhook laat een systeem actief melden dat er iets is gebeurd. Daarbij zijn maatregelen nodig tegen dubbele verwerking, een verkeerde volgorde en tijdelijke onbeschikbaarheid.
CSVXMLJSON
Databases en bestanden
Sommige omgevingen wisselen gegevens uit via een databasekoppeling, geplande exports, CSV, XML, JSON of een ander gestructureerd formaat. We moeten daarbij versies, tekencodering, validatie en foutopvolging expliciet beheren.
Bestaand systeem
Connector
Toepassing
Legacy en maatwerkconnectors
Zonder standaardaansluiting kan een maatwerkconnector of tussenlaag nodig zijn. Eerst onderzoeken we of de koppeling haalbaar is en nadien onderhouden en ondersteund kan worden. Niet elk gesloten of ongedocumenteerd systeem kan verantwoord worden gekoppeld.
Authenticatie, rechten en geheimen
Een integratie krijgt alleen de toegang die ze voor haar functie nodig heeft. Welke methode past, hangt af van het systeem: API-sleutels, OAuth 2.0, OpenID Connect, certificaten of andere methoden.
Toegangsgegevens, tokens en geheime sleutels horen niet in broncode, publieke logs of gewone projectdocumenten. Wie ze mag gebruiken, hoe ze worden beheerd en hoe ze worden vernieuwd, stemmen we af op de verantwoordelijkheden van de betrokken partijen.
Betrouwbaarheid en herstel
Ook wanneer iets misgaat, moet duidelijk zijn wat de integratie doet en hoe herstel mogelijk is. Daarom bepalen we waar relevant:
hoe lang een aanvraag mag wachten en wanneer ze opnieuw wordt geprobeerd (time-outs en retries);
bescherming tegen dubbele verwerking;
wachtrijen of tijdelijke opslag;
validatie en afzondering van foutieve gegevens;
logs, meetwaarden en waarschuwingen;
stappen om manueel te herstellen of opnieuw te verwerken;
wat er gebeurt als een externe API wijzigt of tijdelijk niet beschikbaar is.
We kunnen de beschikbaarheid of blijvende compatibiliteit van een derde partij niet garanderen. In het ontwerp kunnen we wel vastleggen hoe problemen worden ontdekt en welke herstelstappen nodig zijn.
Van proefkoppeling tot verdere werking
Testen, opleveren en onderhouden
Een project kan bestaan uit verkenning, proefkoppeling, ontwerp, ontwikkeling, testen, uitrol en overdracht. Waar mogelijk werken we in een aparte test- of sandboxomgeving en spreken we met vertegenwoordigers van beide systemen de acceptatiecriteria af. Die leggen vast waaraan de koppeling bij oplevering moet voldoen.
Proefkoppeling
Testen
Overdracht
De documentatie legt onder meer de gegevensstromen, configuratie, verantwoordelijkheden, foutafhandeling en het beheer vast. Hosting, monitoring en onderhoud kunt u afspreken via Beheer, onderhoud & outsourcing.
Niet elk softwareprobleem vraagt om een koppeling tussen systemen.
Voor organisaties en technische partners
We werken rechtstreeks voor bedrijven en organisaties en kunnen ook samenwerken met partners en professionals die een connector, API, integratielaag of specialistische technische bijdrage nodig hebben.
Generieke websitebouw en ecommerceontwikkeling behoren niet tot ons aanbod.
Bespreek de systemen én de verantwoordelijkheid
Vermeld welke systemen gekoppeld moeten worden, welke documentatie en testomgeving beschikbaar zijn, wie eigenaar is van de data en wat er bij een fout moet gebeuren.
