This is an old revision of the document!
API Integration Basic Process
- All the following steps need the device to be online
- You can use the ceiba client to check the device's online status and the device's Serial No.
- You can use the web ceiba to check if the API work normally if you received an error
Basic info
- Device Serial No.: 0089000EFD
- Server address:http:IP:12056 (IP and Port is the web ceiba used, the default port is 12056) * Login Username: username (Ceiba client login username) * Login password: password (Ceiba client login password) * KEY:zT908g2j9ng4xe0Nr2n1hbSblgS24wXjZV3o9wsVfNq0q3nEdl%2Fw%3D%3D (This key is a sample, do not use it in your code) * Demo url: http://IP:12056/h5demo/index.html (Visible after login) * API help url:http:IP:12056/help/api/default.html (Visible after login) ===== LiveView ===== 1. Get key Request URL: <code> http://IP:12056/api/v1/basic/key?username=username&password=password </code> Return: <code> {"data":{"key":"zT908g2j9ng4xe0Nr2n1hbSblgS24wXjZV3o9wsVfNq0q3nEdl%2Fw%3D%3D"},"errorcode":200} </code> 2. Get LiveView port Request URL: <code> http://IP:12056/api/v1/basic/live/port?key=zT908g2j9ng4xe0Nr2n1hbSblgS24wXjZV3o9wsVfNq0q3nEdl%2Fw%3D%3D </code> Return: <code> {"data":[{"port":12060},{"port":12061},{"port":12062},{"port":12063}],"errorcode":200} </code> 3. Get LiveView URL Request URL: <code> http://IP:12056/api/v1/basic/live/video?key=zT908g2j9ng4xe0Nr2n1hbSblgS24wXjZV3o9wsVfNq0q3nEdl%2Fw%3D%3D&terid=0089000EFD&chl=1&audio=1&st=0&port=12060&dt=mdvr </code> Return: <code> {"data":{"url":"http://IP:12060/live.flv?devid=0089000EFD&chl=1&st=0&isaudio=1&dt=mdvr"},"errorcode":200}
</code> 4. Open the LiveView <code> Open the demo player, or VLC player, or any other video player which can support playing streaming and input the above LiveView URL to open the LiveView; </code> ===== Playback ===== 1. Search the record list Request URL: <code> http://IP:12056/api/v1/basic/record/filelist?key=zT908g2j9ng4xe0Nr2n1hbSblgS24wXjZV3o9wsVfNq0q3nEdl%2Fw%3D%3D&terid=00880038EE&starttime=2019-04-18%2000:00:00&endtime=2019-04-19%2023:59:59&chl=1,2,3,4&ft=0&st=1 </code> Return: <code> {"data":[{"name":"0-58-0","filetype":1,"chn":2,"starttime":"2019-04-18 00:14:42","endtime":"2019-04-18 00:14:42"},{"name":"0-58-1","filetype":1,"chn":2,"starttime":"2019-04-18 00:14:42","endtime":"2019-04-18 00:14:48"},{"name":"0-60-0","filetype":1,"chn":3,"starttime":"2019-04-18 00:14:42","endtime":"2019-04-18 00:14:48"},{"name":"0-61-0","filetype":1,"chn":4,"starttime":"2019-04-18 00:14:42","endtime":"2019-04-18 00:14:48"},{"name":"0-63-0","filetype":1,"chn":1,"starttime":"2019-04-18 00:14:42","endtime":"2019-04-18 00:14:48"}],"errorcode":200} </code> 2. Get the playback URL Request URL: <code> http://IP:12056/api/v1/basic/record/video?key=zT908g2j9ng4xe0Nr2n1hbSblgS24wXjZV3o9wsVfNq0q3nEdl%2Fw%3D%3D&terid=00880038EE&starttime=2019-04-18%2000:14:42&endtime=2019-04-18%2000:14:48&chl=1 </code> Return: <code> {"data":{"url":"http://IP:8090/play/00880038EE/1/20190418001442_20190418001448_main.m3u8"},"errorcode":200} </code> 3. Playback <code> Open the demo player, or VLC player, or any other video player which can support playing streaming and input the above Playback URL to open the Playback; </code>