Versions and compatibility

These pages describe the EyesOnIt 6.1 REST surface at /api/v1. The path version identifies the API contract family. Product releases have their own version numbers.

Reference source

The resource reference is generated from the current backend OpenAPI contract. Its contract metadata identifies EyesOnIt Backend API, version 1.0.0. Request and response schemas preserve the contract’s field names, discriminators, and constraints.

Authentication guidance also uses the current backend’s shared authentication policy and route handlers. The error guide records the runtime problem envelope where it differs from declared validation schemas.

Upgrade an integration

1. Match the documentation to the EyesOnIt release you deploy.
2. Review operation parameters and request/response models used by your integration.
3. Check enums, optional fields, required fields, and feature requirements.
4. Exercise the relevant reads and authorized writes in a test environment before rollout.

Handle unknown error codes with a fallback that preserves the HTTP status for diagnostics.