Hier leggen we alles uit over (onze) API met een aantal leuke voorbeelden, hoe je hem kunt gebruiken en waarom je hem zou moeten gebruiken.

API staat voor Application Programming Interface. Het is de interface waarmee softwareapplicaties met elkaar kunnen communiceren. In principe kun je iets aanvragen of een vraag stellen, waarna de API-call de actie uitvoert die hij zou moeten uitvoeren, nadat jij hem informatie hebt gegeven.

Stel je voor dat je aan een tafel in een restaurant zit met een menu waar je uit kunt kiezen. De keuken is het deel van het 'systeem' dat je bestelling klaarmaakt. Wat ontbreekt is de cruciale link om je bestelling door te geven aan de keuken en je eten weer bij je tafel af te leveren. Dat is waar de ober, of API, om de hoek komt kijken. De ober is de boodschapper - of API - die je verzoek of bestelling aanneemt en de keuken - het systeem - vertelt wat te doen. Vervolgens levert de ober het antwoord terug aan jou; in dit geval is dat het eten.

Samengevat, wanneer een bedrijf een API aanbiedt aan zijn klanten, betekent dit gewoon dat ze een reeks speciale URL's hebben gebouwd die pure gegevensantwoorden terugsturen - wat betekent dat de antwoorden niet het soort presentatieoverhead bevatten die je zou verwachten in een grafische gebruikersinterface zoals een website.

We hebben vijf API-oproepen die verschillende functies hebben.

Een API oproep bestaat uit drie dingen:

De payload is de informatie die naar een endpoint wordt gestuurd, dat wil zeggen de gegevens die nodig zijn om een deelnemer toe te voegen.

Het eindpunt is een webadres waar de informatie naartoe wordt gestuurd, en de respons geeft aan of de API-aanroep succesvol was of niet.

Webhooks kunnen samen met API-oproepen worden gebruikt om verschillende acties te starten. Als een webhook wordt verzonden die de vereiste payload bevat om een bepaalde API-aanroep te laten werken, zal de API-aanroep zijn werk doen en de deelnemer toevoegen. De webhooks moeten vanuit jouw systeem naar ons eindpunt worden gestuurd en moeten zelf in jouw systeem worden ingesteld.

De volgende paragrafen maken deel uit van een fictieve use case om uit te leggen hoe webhooks en API's kunnen samenwerken.

Een HR manager heeft een instapcursus en examen gemaakt voor nieuw aangenomen werknemers. De HR-manager wil dat de werknemers de cursus volgen, maar wil alleen dat ze toegang krijgen tot het examen na het afronden van de cursus. Pas nadat ze voor het examen zijn geslaagd, willen ze dat de werknemers toegang krijgen tot de Akademia, die cursussen en examens voor gevorderden en experts bevat. Dus, hoe zetten ze dit op?

Om te begrijpen hoe ze dit moeten opzetten, hebben we al vastgesteld dat deze webhooks en API-oproepen intern binnen het Easy LMS-systeem worden verzonden. Het proces is als volgt.

De HR manager moet een webhook aanmaken die een payload naar de examen API stuurt nadat de medewerker de cursus heeft afgerond. Deze webhook hoeft alleen de gegevens te bevatten die nodig zijn om de Examen API aan te roepen. In dit geval gebruiken we de Add participant to Examen (invite) API call. Als deze webhook is verzonden, wordt de API-oproep geactiveerd als er een succesvolle respons is. De API call voegt de deelnemer toe en verstuurt automatisch de uitnodiging voor het examen.

De tweede webhook die de HR manager moet maken is voor wanneer de medewerker het examen met succes heeft afgelegd om toegang te krijgen tot de akademia. Ook hier moet de payload van deze webhook alleen de informatie bevatten die de Akademia API call nodig heeft om de deelnemer toe te voegen en een uitnodiging te sturen. Na het verzenden van deze webhook wordt de API-aanroep van de academie geactiveerd, waarna deze de deelnemer toevoegt aan de academie en een uitnodiging verstuurt.

Samengevat:

Een klant wil onze tool gebruiken voor het trainen van hun (nieuwe) medewerkers. Op dit moment gebruiken ze de instelling Een vooraf gedefinieerde groep deelnemers om uitnodigingsmails te versturen. Veel medewerkers zien deze uitnodigingen echter als spam en sommige van deze e-mails belanden ook in hun spammap. De klant wil deze uitnodigingen in plaats daarvan vanuit zijn eigen systeem versturen.

De klant maakt eerst een webhook aan die een payload naar de Examen API stuurt - deelnemer toevoegen zonder kennisgeving. Wanneer een nieuwe medewerker aan je systeem wordt toegevoegd, stuurt de webhook de payload naar de Examen API die de medewerker toevoegt. De API-aanroep stuurt geen uitnodiging naar deze medewerker. Als de API-aanroep succesvol is, bevat het antwoord aanmeldingsgegevens. Deze inloggegevens moeten dan vanuit je eigen systeem en mailapplicatie naar de medewerker worden gestuurd.

Dit werkt ook voor bestaande werknemers, je hoeft alleen maar een webhook te maken die een payload naar de Examen API stuurt die de actie van het toevoegen van deelnemers triggert zonder het examen aan te melden. De aanmeldingsgegevens die worden teruggestuurd in het antwoord van de API-oproep kunnen dan worden verzonden vanuit je eigen systeem.

Een klant maakt examens in ons systeem en verkoopt deze aan hun eigen klanten via hun e-commerce website. Ze willen dit automatiseren nadat klanten voor een examen hebben betaald.

Om het verkoopproces te automatiseren moeten ze een webhook gebruiken. Wanneer hun klanten een examen kopen of betalen op hun e-commerce website, worden ze toegevoegd aan hun systeem. De webhook die ze maken moet geactiveerd worden nadat ze betaald hebben. Deze webhook stuurt dan de relevante payload naar de API-oproep voor examens en moet een succes- of foutmelding terugsturen. Als het antwoord succesvol is, voegt de API-aanroep klanten toe en nodigt ze uit voor het examen waarvoor ze hebben betaald.
​

Onze API accepteert application/x-www-form-urlencoded of multipart/form-data en json.

Lees meer in de volgende artikelen: