Request design
Make NIXZ requests explicit, observable, and safe to retry.
Treat every endpoint page as a contract. Validate request fields before sending them and keep the exact API reference open while implementing.
Build requests deliberately
Method and URL
Copy both from the endpoint reference; do not infer them from labels.
Headers
Send only documented headers, including authorization where required.
Body
Validate types and required fields before sending a write request.
Observability
Record enough context to debug a failed request without storing personal data or credentials:
- endpoint name and HTTP method
- response status and safe error code
- correlation or request ID when returned
- duration and retry count
Make retries intentional
Retry only transient failures and only when the endpoint semantics allow it. For a write endpoint, confirm idempotency guidance in its API reference page.