Error Handling

Client integrations should handle both transport-level and application-level failures.

Recommended Handling

For every endpoint you integrate with:

• validate required inputs before sending requests
• inspect HTTP status codes
• parse the response body safely, including error payloads
• log failures with enough context for troubleshooting
• avoid exposing sensitive request data in logs

Typical HTTP Response Classes

Practical Guidance

• handle validation failures as expected business or client errors
• treat authentication and authorization failures separately from payload validation errors
• use retries only when the operation is safe to retry
• add timeout handling in your client
• surface actionable messages to developers or operators without leaking secrets

Contract Validation

Error body formats may differ by endpoint or service area. Always verify the documented responses in the API Catalog for the operation you are using.

Troubleshooting Checklist

When investigating an error, capture:

• endpoint path and HTTP method
• environment
• request timestamp
• status code
• sanitized request payload
• sanitized response body
• any correlation or trace identifier returned by the platform, if available