/v1 is application/problem+json (RFC 9457) met een vaste set velden:
code, nooit op detail. code is een stabiel machinecontract; detail is leesbaar voor mensen en kan wijzigen. param is aanwezig wanneer de fout te herleiden is tot een specifieke requestparameter. Vermeld request_id wanneer u contact opneemt met de support.
Foutcodes
De set codes is gesloten: nieuwe codes vormen een wijziging van het openbare contract en worden aangekondigd via de API-changelog. Een
retryable: true-respons betekent dat de situatie zich mogelijk vanzelf oplost; het bewijst niet dat een schrijfactie geen effect heeft gehad. Probeer leesverzoeken opnieuw met een beperkt aantal pogingen en een beperkt tijdsbudget, met exponentiële backoff en jitter. Houd rekening met Retry-After wanneer dit aanwezig is, ook bij een opnieuw te proberen 409 of 429.
Volg voor mutaties het gedocumenteerde idempotentie- en herstelcontract van de bewerking. Behoud de oorspronkelijke sleutel en het oorspronkelijke verzoek wanneer dat wordt ondersteund. Genereer na een timeout of 5xx geen nieuwe sleutel: daardoor kan een geslaagde schrijfactie worden herhaald. Een Idempotency-Key-header biedt geen bescherming bij een bewerking die dit niet ondersteunt.