Een praktische gids van AgentSoft. Voorbeelden van mogelijke AI-toepassingen worden onderscheiden van ons gerealiseerde softwarewerk.
Wat is een API-koppeling?
Een API is een afgesproken interface waarmee software functies of gegevens van een ander systeem kan gebruiken. Een API-koppeling gebruikt die interface om informatie op te halen of door te geven, bijvoorbeeld een opdracht uit een klantportaal naar een planning.
De API van een pakket en de koppeling die u laat bouwen zijn verschillende onderdelen. De leverancier bepaalt wat via zijn API beschikbaar is. De koppeling bepaalt welke gegevens uw proces nodig heeft, hoe velden worden vertaald en wat er gebeurt bij een fout. De zeven vragen hieronder helpen die opdracht afbakenen.
1. Welk systeem is de bron?
Bepaal voor klantgegevens, opdrachten, statussen en documenten afzonderlijk waar de waarheid wordt beheerd. Twee systemen die hetzelfde veld vrij mogen wijzigen veroorzaken snel conflicten. Leg ook vast wat gebeurt als gegevens al bestaan.
2. Wat moet er precies over?
Maak een gegevenslijst met betekenis, formaat en verplichte velden. Een status 'gereed' in het ene pakket kan iets anders betekenen dan 'afgerond' in het andere. Test met voorbeelden uit de dagelijkse praktijk, inclusief lege en afwijkende waarden.
3. Welke toegang is beschikbaar?
Controleer API-documentatie, webhooks, bestandsuitwisseling, limieten en toegangsrechten. Een leverancier kan wijzigingen of kosten aan API-gebruik verbinden. Zonder passende toegang is een automatische koppeling mogelijk niet verstandig.
4. Hoe snel moeten gegevens doorlopen?
Directe verwerking is niet voor ieder proces nodig. Voor een planning kan een gebeurtenis direct nuttig zijn; een rapportage kan wellicht periodiek bijgewerkt worden. De gewenste snelheid beïnvloedt ontwerp en kosten.
5. Wat gebeurt er bij een fout of herhaling?
Een netwerkfout mag geen dossier laten verdwijnen. Ontwerp logging, opnieuw proberen en herkenning van al verwerkte records. Spreek af wie een foutmelding ziet en wanneer handmatige correctie nodig is.
6. Wie mag welke gegevens zien?
Geef een koppeling alleen noodzakelijke rechten. Bespreek hoe sleutels worden beheerd, welke gegevens in logs terechtkomen en hoe toegang bij een wijziging of vertrek wordt ingetrokken.
7. Wie onderhoudt de koppeling?
API's en processen veranderen. Leg vast wie updates controleert, welke tests bij wijzigingen worden gedaan en hoe een storing wordt opgelost. Dat hoort bij de investering, net als de bouw van de eerste verbinding.