Developerplatform

Bouw voort op de grammatica-dataset

De grammatica-API biedt een alleen-lezen, geversioneerde dataset voor lessen, begrippen, voorbeelden, oefeningen, voetnoten en bronnen. Begin met deze gids en ga daarna verder naar Swagger of het ruwe OpenAPI-document zodra je wilt integreren.

Begin hier

De meeste integraties starten best bij de API-index, waar de beschikbare resourcefamilies en de huidige datasetversie worden uitgelegd.

Typische workflow

  • Roep /api/v1/grammar aan om de huidige endpoints en datasetversie te ontdekken.
  • Gebruik /api/v1/grammar/lessons voor de index van gepubliceerde lessen.
  • Laad /api/v1/grammar/lessons/[slug] voor volledige lespayloads.
  • Gebruik /api/openapi.json om clients te genereren of het schema in tooling te importeren.

Integratienotities

  • Responses zijn alleen-lezen en bevatten schemaVersion, datasetVersion en generatedAt.
  • De publieke dataset bevat alleen gepubliceerde lessen en de bijbehorende begrippen, voorbeelden, oefeningen, voetnoten en bronnen.
  • De lesson-filter accepteert zowel een slug als een canonieke les-id.
  • Voor browser-apps op een andere origin is een backendproxy de veiligste standaardoptie.

Voorbeeldrequest

Een minimale server-side fetch die de titels van gepubliceerde lessen ophaalt.

const response = await fetch(
  "https://kyrilloswannes.com/api/v1/grammar/lessons",
);

const payload = await response.json();
const lessonTitles = payload.data.map((lesson) => lesson.title.en);