API staat voor Application Programming Interface. Het is een manier waarop verschillende softwareprogramma’s met elkaar kunnen ‘praten’ en gegevens uitwisselen. Je kan het zien als een soort tolk die ervoor zorgt dat één programma opdrachten kan geven aan een ander programma, zonder dat je precies hoeft te weten hoe dat andere programma van binnen werkt.
Met een API kan je:
– Gegevens ophalen uit een ander systeem (bijvoorbeeld klantgegevens of planningsinformatie).
– Acties uitvoeren in een ander systeem (bijvoorbeeld een opdracht aanmaken of een factuur versturen).
– Automatiseren door verschillende systemen met elkaar te verbinden, zodat je handmatig werk bespaart.
Kortom: een API maakt het mogelijk om software slimmer te laten samenwerken en processen efficiënter te maken.
Ga hiervoor naar Instellingen → Algemene instellingen → API.
1. API-overzicht
Onder het tabblad API zie je alle beschikbare opties en bestaande API-sleutels. Dit is de centrale plaats waar je koppelingen kan beheren.
Daarnaast vind je er ook:
– Endpoints: de adressen waarmee andere software verbinding maakt om gegevens uit te wisselen.
– Documentatie: een handleiding die uitlegt welke mogelijkheden er zijn en hoe je de API correct gebruikt. Deze informatie is vooral handig voor technische partners of ontwikkelaars.
2. API-sleutels beheren
Een API-sleutel is een soort digitale sleutel waarmee systemen veilig met elkaar kunnen communiceren.
Je kan:
– Een nieuwe sleutel aanmaken via de blauwe knop Nieuwe API-sleutel.
– Bestaande sleutels bekijken in de lijst.
– Sleutels verwijderen: dit kan één per één of meerdere tegelijk door ze te selecteren en Rijen verwijderen te kiezen.
3. API-logs
Wil je controleren of een koppeling goed werkt? Dat kan via de API-logs.
Klik op API-logs tonen om de logs te openen.
In de logs kan je filteren op:
– Alle API-aanroepen
– Enkel geslaagde aanroepen
– Enkel mislukte aanroepen
De logs geven inzicht in:
– Welke API-sleutel gebruikt werd
– Welke methode is aangeroepen
– De meegegeven parameters
– Het antwoord van de API
Zo heb je meteen duidelijkheid of een koppeling correct werkt.
Wil je meer informatie of ondersteuning bij jouw API-koppeling? Contacteer dan gerust onze supportafdeling.