v1.0

Inzicht-API

Fouten

Elke fout is kort en Nederlands, in {"fout": "…"}. Geen Laravel-validatie-envelope, geen Engelse message.

Statuscodes

  • 401 — geen of ongeldige sleutel
  • 402 — tegoed op
  • 403 — dit recht zit niet op de sleutel
  • 404 — adres of bron niet gevonden
  • 422 — ongeldige input, of te weinig data om te schatten
  • 429 — te snel
  • 503 — een bronsysteem is plat

De vorm

{"fout": "Adres niet gevonden."}

Bij 402 komt saldo mee, zodat je niet extra whoami hoeft te doen:

{
  "fout": "Tegoed op.",
  "saldo": {
    "credits": 0,
    "eenheid_cent": 5,
    "tegoed_cent": 0
  }
}

Bij 422 op marktwaarde kan betrouwbaarheid meekomen: we kennen het adres, maar te weinig vergelijkbare verkopen — dan komt er bewust geen getal.

Wat credits kost

Een 404 kost niets. Een 401, 403 of 429 ook niet: je hebt niets geleverd gekregen. Een 200 en een 422 wegens onvoldoende data wel. Zie Teller.

Klopt er iets niet of ontbreekt er iets? [email protected]