Guides ยท Technology
API Error Handling Basics
Return errors clients can use
Effective API error handling maps failures to accurate HTTP codes, returns concise messages with correlation IDs, avoids leaking secrets, and documents retry/backoff guidance for clients.
- api errors
- http status
- correlation id
- retry
- messages
Use Proper Codes
Match errors to 4xx/5xx codes; avoid 200 on failure.
Return Context
Provide short messages, correlation/request IDs, and retry hints.
Protect Data
Do not leak stack traces or secrets; log details server-side.