Documentation Center Overview

The Eye4Cloud Open Platform provides device integration, live video, alarm callbacks, online status, RTSP streaming, and device control for cameras, network cameras, IPC devices, and 4G cameras. It supports camera solutions, customized camera solutions, and professional security projects.

Start Integration

For your first integration with the Eye4Cloud Open Platform, follow this reading order:

  1. Integration Workflow
  2. Sign Generation Examples
  3. Device Management Documentation
  4. Audio & Video

Before integration, contact the Eye4Cloud integration owner to obtain the open_id and secret key, and confirm the device type ID and model ID for the device to be integrated (Contact: Engineer Lin; phone/WeChat: 13424300928)

Documentation Navigation

Document Module Key Content Use Case
Integration Workflow Integration preparation, device creation, and WebRTC playback First Integration
Sign Generation Examples open_id, secret key, and sign generation Server-side API calls
Device Management Device creation, querying, updating, and deletion Device lifecycle management
Audio & Video Live video, snapshots, recordings, two-way audio, AI detection, motion detection, and night vision modes Camera audio/video and intelligent analysis capabilities
Alarms and Events Alarm callbacks, image events, and video events Security monitoring applications
Online/Offline Status Heartbeat and device status synchronization Device online status
RTSP Streaming Get the device RTSP stream URL Server-side video streaming
CGI Control Commands Camera parameters and device feature control Device Control
Device Zone (GS/GE) Photo Smoke Detectors and Pull-cord Alarm Devices Specialized device integration

Find Documentation by Scenario

Development Scenario Recommended Reading
First Device Integration Integration Workflow -> Sign Generation Examples -> Device Management Documentation
Play Live Camera Video Device Management Documentation -> Audio & Video
Get Snapshots, Recordings, or Two-way Audio Audio & Video
Receive Camera Alarms Sign Generation Examples -> Alarms and Events
Get Device Online Status Sign Generation Examples -> Online/Offline Status
Get an RTSP Video Stream RTSP Streaming
Control Camera Features CGI Control Commands
Integrate 4G or Specialized Devices Device Zone (GS/GE)

Documentation Notes

This documentation center is organized from the current Eye4Cloud Open Platform technical materials. Use the corresponding technical document as the source of truth for API paths, request fields, response parameters, and code examples. Check the device-specific documentation to confirm model support.