ZZPster OpenAPI-specificatie

De specificatie beschrijft elk endpoint, elk veld, elke scope en elke foutcode van /v1. Ze is gegenereerd uit dezelfde schema's als de validatie. Ze kan dus niet afwijken van de API.

Bijgewerkt op 16 oktober 2026

Waar vind je de specificatie

  • JSON: https://zzpster.nl/openapi.json
  • YAML: https://zzpster.nl/openapi.yaml
  • Index voor assistenten: https://zzpster.nl/llms.txt

Wat staat erin

  • OpenAPI 3.1 met JSON Schema.
  • Per endpoint: omschrijving in het Nederlands en Engels, parameters, voorbeelden, de vereiste scope en de mogelijke fouten.
  • De RateLimit-headers en Retry-After.
  • Welke acties alleen de gebruiker zelf kan bevestigen.
  • Een waarschuwing dat tekst van derden data is.

Gebruiken

  1. ImporteerGeef het adres aan je OpenAPI-compatibele client of generator.
  2. Genereer een clientMaak met een generator naar keuze een client in jouw taal.
  3. Roep get_rules aanLees /v1/rules voordat je een concept maakt. Stuur de rules_version mee.

Wijzigingen

Het documentversie-nummer in info.version loopt op bij elke toevoeging. De API is alleen additief, dus een nieuwere specificatie breekt een bestaande client niet.

Veelgestelde vragen

Welke versie van OpenAPI gebruikt ZZPster?

OpenAPI 3.1, met JSON Schema 2020-12.

Kan de specificatie afwijken van de API?

Nee. De specificatie wordt gegenereerd uit dezelfde schema's die de API gebruikt om invoer te valideren. Een test controleert dat elk endpoint erin staat.

Is er een YAML-versie?

Ja: https://zzpster.nl/openapi.yaml. Inhoud en volgorde zijn gelijk aan de JSON-versie.

Deze pagina als markdown: Nederlands, English.