Getting started

Prepare an integration and verify your first request.

Start with one small read-only flow. It validates connectivity, authentication, and response handling before you build product logic around an endpoint.

Before you start

  • Use a server-side integration for credentials and privileged requests.
  • Keep separate configuration for development, test, and production.
  • Confirm each endpoint's required headers and permissions in API reference.

First request

Open the endpoint in API reference and inspect its required inputs.

Send the request from a secure server environment.

Log only status, request ID, and safe metadata while validating the response.

# Replace placeholders with values from the selected API reference endpoint.
curl --request GET "https://api.example.com/resource" \
  --header "Authorization: Bearer $NIXZ_ACCESS_TOKEN" \
  --header "Accept: application/json"

Do not ship placeholders

api.example.com and resource are illustrative only. Copy the exact URL, method, and request fields from the endpoint page before implementation.

On this page