API
Paden
POST /v1/controleer | Fouten in een tekst |
|---|
POST /v1/ontleden | Zinsdelen en woordsoorten |
|---|
POST /v1/oefeningen | Oefeningen op precies één regel, uit een gekeurde bank |
|---|
POST /v1/profiel | Van meldingen naar wat de klas eerst oefent |
|---|
GET /v1/categorieen | Alle foutsoorten |
|---|
GET /v1/regels | Regelsleutels met naam en, waar we die hebben, referentieniveau |
|---|
GET /v1/profielen | De uitlegprofielen op deze server |
|---|
GET /health | Status, versie en opstelling |
|---|
Velden van POST /v1/controleer
| Veld | Standaard | Wat |
|---|
tekst | verplicht | UTF-8, maximaal 10.000 tekens |
|---|
niveau | oplossing | hint, regel of oplossing. De server filtert, dus een leerling-client kan de oplossing niet uit het antwoord halen |
|---|
min_zekerheid | 0.75 | Lager geeft meer vondsten en minder precisie |
|---|
categorieen | alle | Prefix op categorie-id, zoals werkwoordspelling |
|---|
appjes | zwijgen | melden bij schrijfopdrachten, verslagen en toetsen |
|---|
uitlegprofiel | standaard | De termen van jouw methode, of en voor Engels |
|---|
Wat er per niveau terugkomt
| Niveau | Velden |
|---|
hint | plek, span, categorie, hint |
|---|
regel | ook uitleg, stappen, regelsleutel, kenmerken, zekerheid, bron |
|---|
oplossing | ook correctie en alternatieven |
|---|
Fouten
400 lege of te lange tekst of onbekend veld. 403 geen toegangsbewijs, alleen op het openbare adres: dat is voor mensen in de browser, een koppeling krijgt een eigen server. 413 body te groot. 429 rate limit, alleen als de server er een heeft. De invoer komt nooit terug in een foutmelding.
Posities staan er in codepoints (start, eind) en in UTF-16 (start_utf16, eind_utf16, voor JavaScript). Een OpenAPI-beschrijving staat op /docs van elke server, ook op de demo.