DEVELOPER OVERVIEW
A video layer for
your application.
Keep your application’s own users, permissions and interface. Use vigilsyn’s Cloud API from your backend to select cameras and grant limited playback access.
1. Authorize your backend
Create a scoped application key in Cloud. Give it only the cameras and permissions your application needs. Store that key in a server-side secret or environment variable; never put it in a browser bundle, iframe URL or public repository.
2. List available cameras
curl --fail-with-body \
-H "Authorization: Bearer $VIGILSYN_API_KEY" \
"https://console.example.com/api/v1/cameras"The response contains a cameras array. Store the returned camera id when mapping a camera to part of your application. Display names may change; use the returned ID rather than constructing one from the name.
3. Request limited playback access
curl --fail-with-body \
-H "Authorization: Bearer $VIGILSYN_API_KEY" \
-H "Content-Type: application/json" \
--data '{"cameras":["site-a/entrance/main"],"ttl":300}' \
"https://console.example.com/api/v1/playback/token"This is an illustrative camera path. Use an ID and permitted profile returned by your own Cloud. Your backend must first check that its signed-in user may view the requested camera. Return only the short-lived playback token and approved playback details to that user.
4. Play and renew
Use the vigilsyn player/SDK with your Cloud stream endpoint and approved token. Renew through your backend before expiry. A playback token is a bearer credential: keep its scope narrow and avoid logging it.
Plan for the browser and network
- Use trusted HTTPS for production applications and public stream endpoints. An HTTPS page cannot freely embed insecure HTTP media.
- WebRTC needs reachable media endpoints and compatible codecs. HLS can be an alternative when the deployment or client needs it.
- Do not disable certificate verification. Install a trusted private CA when you operate your own certificate authority.
- Cloud and Edge need active licenses or valid signed grace periods for live streaming.
Recording and PTZ APIs are also available for supported cameras and NVRs. Exact permissions, capabilities and endpoint behavior depend on the node and installed release.