REST API overview
Use the EyesOnIt REST API to connect camera workflows to your own applications. Requests use your server’s HTTPS address and the /api/v1 base path.
The examples use Bash, cURL 7.87 or newer, and Python 3 for JSON preparation. Set the address of your server before sending requests.
export EOI_API_BASE_URL="https://eyesonit.example/api/v1"Choose your authentication
Section titled “Choose your authentication”A service token suits supported server integrations. Ask your administrator to issue the capabilities needed for your workflow. A user session suits work that requires a signed-in administrator or a selected customer workspace. Follow Authentication and permissions to set up either option.
Make your first requests
Section titled “Make your first requests”Make your first request walks through listing cameras and reading one camera by ID. These reads require monitor:read.
Then choose an integration guide for a complete workflow or browse the API reference for operation parameters and schemas.
Examples use fictional IDs and camera names. Replace them with resources on your server before running a request. A write request changes server state when it succeeds.