Dit artikel is ook beschikbaar in:
Dit artikel is vertaald met behulp van machinevertaling. Hierin zijn mogelijk foutieve of vreemde vertalingen aanwezig. Vooralsnog denken we dat het waardevol is om dit hulpartikel in jouw moedertaal te kunnen lezen. Laat ons onderaan het artikel weten of het artikel nuttig was en of je nog andere feedback voor ons hebt.

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

1. Wat is API?

API staat voor Applicatie Programmeer Interface. Het is de interface die software toepassingen in staat stelt met elkaar te communiceren. In principe kun je er iets mee aanvragen, of een vraag stellen, waarna de API aanroep de actie uitvoert die hij moet doen, nadat je hem informatie verstrekt hebt.

Voorbeeld 1

Als je in je browser naar Facebook gaat, gaat er een verzoek uit naar de externe server van Facebook. Zodra je browser het antwoord ontvangt, interpreteert hij de code en geeft de pagina weer.

Voor de browser, ook wel de client genoemd, is de server van Facebook een API. Dit betekent dat elke keer dat je een pagina op het Web bezoekt, je in wisselwerking treedt met een of andere remote server's API.

Een API is niet hetzelfde als de externe server - eerder het is het deel van de server dat verzoeken ontvangt en antwoorden zendt.

Voorbeeld 2

Stel je voor dat je in een restaurant aan tafel zit met een menu van keuzes om uit te bestellen. De keuken is het deel van het "systeem" dat je bestelling klaarmaakt. Wat ontbreekt is de kritieke schakel om je bestelling aan de keuken door te geven en je eten weer bij je tafel af te leveren. Dat is waar de ober, of API, om de hoek komt kijken. De kelner is de boodschapper - of API - die je verzoek of bestelling aanneemt en de keuken - het systeem - vertelt wat te doen. Dan levert de ober het antwoord weer bij je af; in dit geval is dat het eten.

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

2. Waarvoor gebruik ik het?

Ontwikkelaars kunnen verschillende API's op verschillende manieren gebruiken om verschillende dingen te bouwen. Facebook is een goed voorbeeld; de site lanceerde zijn ontwikkelaarsplatform dat F8 heet en nu een verbazingwekkende 10.900 toepassingen herbergt, van het beruchte Scrabulous tot instant messaging en voedselgevecht spelletjes.

Het voordeel voor de gastsite is dat hij veel nieuwe, coole functies gratis krijgt, terwijl de ontwikkelaars hun werk op een meer in het oog springende site kunnen promoten en op het werk van iemand anders kunnen voortbouwen. De meeste van deze toepassingen worden gebouwd door bedrijven met een eigen website - vaak kleinere bedrijven met minder verkeer die van de cross-over profiteren. Zo heeft filmrecensiesite Flixster een populaire Facebook toepassing, net als Last.fm en de foto-sharing site Flickr.

3. Welke API oproepen heeft Easy LMS?

We hebben zes API oproepen die verschillende functies hebben:

Deelnemer toevoegen aan Examen (uitnodigen)
Voeg deelnemer toe aan Examen zonder te melden (geen uitnodiging)
Deelnemer toevoegen aan Cursus (uitnodigen)
Deelnemer toevoegen aan Academy (uitnodigen)
Deelnemer toevoegen aan Academy zonder verwittiging (geen uitnodiging)
Deelnemer verwijderen (verwijdert alle deelnemergegevens definitief uit ons systeem)

De API aanroepen voor een Examen werken alleen als de toegang is ingesteld op Een vooraf gedefinieerde groep deelnemers, of voor een Cursus die Alleen door uitnodiging. Dit spreekt voor zich voor de Academy. Het is ook niet mogelijk een van deze oproepen te gebruiken voor hetzelfde Examen, Cursus, of Academy als er al een deelnemer aan toegevoegd is. Het doel van deze API oproepen is namelijk om deelnemers toe te voegen, dus als ze al toegevoegd zijn, werkt de API oproep niet.

Een API aanroep bestaat uit drie dingen:

De payload (de eigenlijke gegevens die verstuurd worden)
Het eindpunt (het adres waar de gegevens naartoe gestuurd worden)
Het antwoord (succes- of foutmelding)

De payload is de informatie die naar een eindpunt gezonden wordt, d.w.z. de gegevens die nodig zijn om een deelnemer toe te voegen/te verwijderen.

Het eindpunt is een webadres waar de informatie naartoe gestuurd wordt, en het antwoord geeft aan of de API oproep geslaagd was of niet.

4. Webhooks

Webhooks kunnen samen met API oproepen gebruikt worden om verschillende acties in gang te zetten. Als een webhook gezonden wordt die de vereiste payload bevat om een bepaalde API aanroep te laten werken, zal de API aanroep zijn werk doen en de deelnemer toevoegen/verwijderen. De webhooks moeten van je systeem naar ons eindpunt gestuurd worden. Dit is iets wat je zelf in je systeem zou moeten instellen.

Voorbeeld 1 - Cursus, Examen, Academy

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 instaptoets Cursus en Examen gemaakt voor pas aangenomen werknemers. De HR manager wil dat de werknemers de Cursus afleggen, maar wil dat ze pas toegang krijgen tot de Examen nadat ze de Cursus hebben afgelegd. Pas nadat ze geslaagd zijn voor de Examen wil hij dat de werknemers toegang krijgen tot de Academy, die tussentijdse en expert-niveau Cursuss en examens bevat. Dus, hoe stellen ze dit op?

Om te begrijpen hoe dit opgezet moet worden hebben we al vastgesteld dat deze webhooks en API calls intern binnen het Easy LMS systeem gestuurd zullen worden. Het proces verloopt als volgt:

De HR manager moet een webhook maken die een payload naar de Examen API stuurt nadat de werknemer de cursus voltooid heeft. Deze webhook hoeft alleen de gegevens te bevatten die nodig zijn om de Examen API oproep te activeren. In dit geval gebruiken we de Deelnemer toevoegen aan Examen (uitnodigen) API oproep. Als deze webhook verzonden is, wordt de API aanroep getriggerd als er een succesantwoord is. De API aanroep voegt de deelnemer toe en verstuurt automatisch de Examen uitnodiging.

De tweede webhook die de HR manager moet maken is voor als de werknemer met succes slaagt voor de Examen om toegang te krijgen tot de Academy. Ook hier moet de payload van deze webhook alleen de informatie bevatten die de Academy API aanroep nodig heeft om de deelnemer toe te voegen en een uitnodiging te sturen. Na het versturen van deze ''Examen geslaagd'' webhook wordt de Academy API call getriggerd, waarna die de deelnemer toevoegt en een uitnodiging stuurt voor de Academy.

Samenvattend:

Maak webhook voor Cursus voltooiing die naar de Examen API oproep gestuurd wordt.
Maak webhook voor het doorgeven van Examen die naar de Academy API oproep gestuurd wordt.
Medewerker neemt Cursus aan en voltooit het.
Webhook voor Cursus voltooiing wordt gestuurd naar Deelnemer toevoegen aan Examen (uitnodigen) API call eindpunt en voegt deelnemer toe en nodigt uit voor het Examen.
Werknemer neemt Examen en slaagt.
Webhook voor het slagen voor Examen wordt gestuurd naar Deelnemer toevoegen aan Academy (uitnodigen) API call endpoint en voegt deelnemer toe en nodigt uit voor het Academy.



Voorbeeld 2 - Uitnodigingen zenden vanuit je eigen systeem

Een klant wil ons hulpmiddel gebruiken voor de opleiding van zijn (nieuwe) medewerkers. Ze gebruiken momenteel de Een vooraf gedefinieerde groep deelnemers instelling om uitnodigingsmails te sturen. Veel medewerkers ervaren deze uitnodigingen echter als spam, en sommige van deze emails belanden ook in hun spammappen. De klant wil deze uitnodigingen in plaats daarvan vanuit zijn eigen systeem versturen.

De klant maakt eerst een webhook die een payload stuurt naar de Examen API - deelnemer toevoegen zonder te melden. Als 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 werknemer. Als de API aanroep succesvol is, bevat het antwoord aanmeldingsgegevens. Deze inloggegevens moeten dan vanuit je eigen systeem en mailprogramma naar de werknemer gestuurd worden.

Dit werkt ook voor bestaande medewerkers, je hoeft alleen maar een webhook te maken die een payload naar de Examen API stuurt die de actie van het toevoegen van deelnemers in gang zet zonder het Examen op de hoogte te brengen. De aanmeldingsgegevens die in het antwoord op de API oproep worden teruggestuurd kunnen dan vanuit je eigen systeem worden verstuurd.

Voorbeeld 3 - Verkopen Examens

Een klant maakt Examens in ons systeem en verkoopt ze aan zijn eigen klanten vanaf zijn e-commerce website. Hij wil dit automatiseren nadat zijn klanten voor een Examen betaald hebben.

Om zijn verkoopproces te automatiseren zal hij een webhook moeten gebruiken. Als zijn klanten op zijn e-commerce website een Examen kopen of betalen, worden ze aan zijn systeem toegevoegd. De webhook die hij maakt moet getriggerd worden nadat ze betaald hebben. Deze webhook stuurt dan de relevante payload naar de Examen API call en moet een(n) succes- of foutantwoord teruggeven. Als het een succesvol antwoord is, voegt de API aanroep zijn klanten toe en nodigt ze uit op de Examen waarvoor ze betaalden.



5. Wat zijn de specificaties van de API aanroep?

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

Meer informatie vind je in de volgende artikelen:

API aanroepen voor Examens en Academy

API aanroep voor Cursuss

Verwijder deelnemer API
Was dit artikel behulpzaam ?
annuleren
Dank je wel !