Dit artikel geeft een kort overzicht van onze API. Er wordt uitleg gegeven over de eindpunten, het gebruik van onze mock data en de beperkingen.
Deze API is een uitgebreid hulpmiddel voor het beheren van online leeromgevingen, gericht op eenvoudige integratie van cursussen en tools en efficiënt beheer van onderwijsbronnen. Het is een essentiële bron voor ontwikkelaars in de ed-tech ruimte, die de nodige technische details biedt om een naadloze online leerervaring te bouwen en te onderhouden.
Swagger
Bekijk voor meer informatie en testen de documentatie hier: Swagger API
API-overzicht
- Doel: De LtiSaas API is ontworpen om de integratie en het beheer van online leeromgevingen te vergemakkelijken. Het richt zich op het omgaan met cursussen, LTI-tools (Learning Tools Interoperability) en leerobjecten.
- Doelgroep: Deze API is gericht op ontwikkelaars die werkzaam zijn in de onderwijstechnologiesector, met name degenen die betrokken zijn bij het beheren van online cursussen en het integreren van verschillende onderwijstools.
Versiebeheer
- Versies: De API heeft twee primaire versies – v0 en v1.
- v0 is een testversie die API-reacties simuleert zonder werkelijke database-interactie. Het is nuttig voor ontwikkelings- en testdoeleinden.
- v1 is de productieversie, bedoeld voor live-omgevingen. Het gaat om echte gegevens en acties.
Eindpunten en Operaties
U vindt eindpunten voor gebruik in de volgende categorieën.
Cursusbeheer
- Cursus aanmaken: Nieuwe cursussen aan het systeem toevoegen.
- Cursus bijwerken: Details van bestaande cursussen wijzigen.
- Lijst met cursussen: Een lijst van alle cursussen ophalen, met filters en zoekmogelijkheden.
- Cursus verwijderen: Cursussen uit het systeem verwijderen.
Integratie van LTI-tools
- LTI-tool toevoegen: Integreer nieuwe LTI-tools in de cursusomgeving.
- LTI-tool bijwerken: Instellingen of details van bestaande LTI-tools wijzigen.
- Lijst LTI-tools: Een lijst opvragen van alle LTI-tools die bij cursussen horen.
- LTI-tool verwijderen: LTI-tools verwijderen uit cursussen.
Beheer van leerobjecten
- Leerobjecten beheren: Dit omvat het toevoegen, bijwerken en verwijderen van leerobjecten zoals SCORM-pakketten. (Momenteel beperkt tot alleen SCORM-pakketten)
Gegevensindelingen en protocollen
- JSON-indeling: De API communiceert met JSON voor zowel verzoeken als antwoorden. Dit omvat het verzenden van gegevens (zoals cursusdetails of LTI-tool instellingen) en het ontvangen van gegevens (zoals lijsten met cursussen of statusberichten).
- HTTP-methoden: Er worden voornamelijk GET- en POST-methoden gebruikt. GET wordt gebruikt voor het ophalen van gegevens, terwijl POST wordt gebruikt voor het verzenden van gegevens naar de server, inclusief het uploaden van bestanden.
Authenticatie en beveiliging
- Toegangsmunten: De API gebruikt toegangsmunten voor authenticatie. Deze tokens zorgen ervoor dat alleen bevoegde gebruikers bepaalde bewerkingen kunnen uitvoeren.
- Beveiligingspraktijken: Terwijl de testversie misschien eenvoudiger authenticatie gebruikt, maakt de productieversie waarschijnlijk gebruik van robuustere beveiligingsmaatregelen om gevoelige gegevens te beschermen.
Behandeling van reacties en beperkingen
- Paginering en limieten: De API legt een limiet op aan het aantal items dat wordt geretourneerd in een enkel antwoord, zoals een maximum van 2500 resultaten per verzoek. Dit is om prestaties en beheerbaarheid te garanderen.
- Foutafhandeling: Het bevat waarschijnlijk standaard HTTP-antwoordcodes om succes, fouten of problemen met verzoeken aan te geven, zodat ontwikkelaars verschillende scenario’s kunnen begrijpen en effectief kunnen afhandelen.
Gebruikssituaties en praktische toepassingen
- Onderwijsinstellingen en platforms voor online leren: Ideaal voor universiteiten, aanbieders van online cursussen en bedrijven op het gebied van onderwijstechnologie.
- Integratie met leerbeheersystemen: Kan worden gebruikt om de mogelijkheden van bestaande LMS-platforms uit te breiden door cursussen en tools toe te voegen of te beheren.
Extra functies
- Documentatie en ondersteuning: De documentatie kan voorbeelden van verzoeken en antwoorden, foutcodes en tips voor probleemoplossing bevatten. Ondersteuningskanalen of forums kunnen beschikbaar zijn voor ontwikkelaars die hulp zoeken.
