Skip to content

Common issues and solutions when integrating with the Zimark REST API.

Authentication Errors

401 Unauthorized

Cause: Missing or invalid API key

Solutions:

  • Verify X-AUTH-KEY header is included in request
  • Check API key format starts with ZIM.
  • Confirm key hasn't been deleted in Backoffice
  • Ensure correct environment (staging vs production)

API Request Errors

400 Bad Request

Cause: Invalid request format or missing required fields

Solutions:

  • Validate JSON syntax
  • Check required fields in API Reference
  • Verify date formats match ISO-8601
  • Ensure enum values are valid

404 Not Found

Cause: Invalid endpoint or resource doesn't exist

Solutions:

  • Verify base URL (production vs staging)
  • Check endpoint path in API reference
  • Confirm resource ID exists

Api logging

All API requests are logged in the Zimark Backoffice. Use these log to debug integration issues and verify request/response data.

Access logs:

  1. Navigate to API log
  2. Filter by date, method, or response status code
  3. Click a request to view details (headers, body, response)

Integration logs

Single request view

Use logs to:

  • Verify requests reach Zimark
  • Debug authentication issues
  • Check exact request/response payloads
  • Identify webhook delivery problems

Still Having Issues?

Contact Zimark support with:

  • Request ID from integration logs
  • Error message and status code
  • Steps to reproduce