Integration Workflow

This guide describes the basic workflow for integrating camera, security camera, and 4G camera solutions with the Eye4Cloud Open Platform. For your first integration, complete the following server-side and client-side steps.

Integration Workflow

1. Get Open Platform Credentials

Contact the Eye4Cloud integration owner to obtain the open_id and secret key (Contact: Engineer Lin; phone/WeChat: 13424300928)

Security note: The secret key is an internal server-side secret used only to generate sign. Store it on the server or in a secure configuration center. Never place it in a frontend, app, or mini program, and never pass it through an external request.

2. Confirm the Device Type ID and Model ID

Confirm the device type ID and model ID for the device to be integrated. Both IDs are required when creating a device. See Type & Model Mapping.

3. Signature & Auth

The server generates sign according to the Open Platform signing rules for API request authentication. See Sign Generation Examples for the detailed rules.

4. Create Device

Prepare the device type ID, model ID, and device information, then call the following API to create the device:

Code Example
POST https://open.eye4cloud.com/{{open_id}}/open/v1/device/create

See Create Device for the detailed request fields.

5. Get WebRTC Playback URL

After the device is created successfully, the server calls the following API to obtain the camera WebRTC playback URL:

Code Example
POST https://open.eye4cloud.com/{{open_id}}/open/v1/device/getWebrtcAddress

See Get WebRTC Stream URL for the detailed request fields.

6. Play Video in the Frontend Player

The server returns the WebRTC playback URL to the frontend, which uses a player or WebRTC SDK to play the video.

7. Integrate Alarms, Online/Offline Status, RTSP, and Other Capabilities

Continue with the following capabilities as required by your business: