Skip to main content
Jira progress: loading…

API-GS

Getting Started

1. Environments

  • sandbox.api.zayaz.io
  • api.zayaz.io

2. Authentication

  • API keys (for server-side integrations).
  • OAuth2 / Client Credentials (for larger partners).
  • JWT for user-level auth.

3. Versioning

  • URI-based or header-based (e.g. v1, v2).

4. Error Handling

  • Error envelope structure:
{
"error": {
"code": "VALIDATION_FAILED",
"message": "…",
"details": { ... },
"trace_id": "..."
}
}

5. Rate Limits

  • General guidance + response headers.


GitHub RepoRequest for Change (RFC)