Skip to main content

Authentication

Wize Snap API routes use API-key authentication only.

Pass your key in the x-api-key header on every API request.

x-api-key: wz_live_your_api_key

Protected Routes

Only these external API routes are exposed for API-key access:

  • POST /api/v1/snap
  • POST /api/v1/snap/comms

Other backend routes remain product-internal unless explicitly documented.

Error Shape

Invalid credentials return 401.

{
"message": "Invalid or inactive api key",
"error": "Invalid or inactive api key",
"statusCode": 401
}

Rate Limiting

Every request to /api/v1/snap and /api/v1/snap/comms is rate-limited to 120 requests per minute, tracked per client IP address — not per API key. If multiple integrations share an outbound IP (for example, behind the same NAT gateway), they share this limit.

Every response includes the current limit status:

X-RateLimit-Limit: 120
X-RateLimit-Remaining: 119
X-RateLimit-Reset: 42

Exceeding the limit returns 429, plus a Retry-After header (seconds until the window resets):

{
"success": false,
"message": "ThrottlerException: Too Many Requests",
"error": "ThrottlerException: Too Many Requests",
"statusCode": 429,
"timestamp": "2026-06-23T13:30:00.000Z"
}