Ga naar inhoud
Documentatie
Integraties
API
API-documentatie

API-documentatie

Wat de Linqur API doet, hoe je authenticeert, het verschil tussen v0 en v1, en waar elk endpoint beschreven staat.

Met de Linqur API beheer je je platform vanuit je eigen systemen. Je kunt cursussen aanmaken en bijwerken, SCORM-pakketten toevoegen of vervangen, per klant een LTI-tool aanmaken, gebruikers en registraties uitlezen voor je rapportages, sign-up URL’s aanmaken en gebruikers inschrijven vanuit een webshop of CRM, bestanden in de bestandsopslag bijwerken, SCORM Proxy-wrappers beheren en API-tokens beheren. Verzoeken en antwoorden zijn JSON. De 40 endpoints staan beschreven in tien groepen; de volledige lijst vind je op API-endpointdocumentatie.

Authenticatie

Elk verzoek bevat een API-sleutel in de HTTP-header Access-Token. Je maakt een sleutel aan in Linqur, zie Een API-sleutel maken. Iedereen met de sleutel kan cursussen, tools en gebruikers op je platform aanmaken en verwijderen. Houd hem dus buiten client-side code en buiten versiebeheer.

Versies: v0 en v1

De API heeft twee versies, elk met een eigen basis-URL op je platform.

VersieBasis-URLWat hij doet
v0https://<your-platform>/local/ltisaas/api.php/v0Geeft testdata terug. Verandert niets en valideert niets. Gebruik het token dummy.
v1https://<your-platform>/local/ltisaas/api.php/v1Werkt op de echte data van je platform. Gebruik je eigen API-sleutel.

Bouw je koppeling eerst tegen v0 om het formaat van de verzoeken en de vorm van de antwoorden te controleren. Zet daarna de basis-URL en het token om naar v1.

Verzoeken en antwoorden

  • Elk endpoint accepteert GET en POST. Uploads, zoals een SCORM-pakket, moeten als POST met multipart/form-data. Sommige endpoints verwachten een JSON-body; de groepspagina’s laten zien welke.
  • Antwoorden zijn JSON. De meeste aanroepen geven success: true terug met de data. Een fout geeft success: false met error en debuginfo, en HTTP-status 400 (ongeldig verzoek) of 401 (token ontbreekt of is ongeldig).
  • Een antwoord bevat maximaal 2.500 resultaten.
  • De rapportage-endpoints verwachten datums in het formaat DD-MM-YYYY.

Swagger op je eigen platform

Je platform heeft een interactieve Swagger-pagina op https://<your-platform>/local/ltisaas/swagger/. Die toont elk endpoint met zijn parameters en laat je verzoeken versturen vanuit de browser. De Swagger-pagina is alleen in het Engels.

De Swagger-pagina van een Linqur-platform met de serverkeuze, het domeinveld en de knop Authorize gemarkeerd

  1. Kies de server (1): v0 voor testdata of v1 voor je echte data.
  2. Vul het domein van je platform in (2).
  3. Klik op Authorize (3) en plak je API-sleutel, of dummy voor v0.

Een verzoek dat je vanuit Swagger op v1 verstuurt, draait op je echte platform. Een aanroep van een delete-endpoint verwijdert echt.

Endpoints per groep

Praktische toepassingen van de API beschrijft veelvoorkomende taken en de endpoints die je daarvoor nodig hebt. Werk je met no-code tools, lees dan hoe je e-learning automatiseert met n8n en Linqur of met Make en Linqur.

Laatst bijgewerkt op
API-endpointdocumentatie