public:ceiba2:api

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
public:ceiba2:api [2021/08/26 19:18]
europe 		public:ceiba2:api [2021/09/20 18:27] (current)
europe
Line 1: Line 1:
-====== Ceiba2 API Integration Basic Process ======+====== API Integration ======
  
 <note tip> <note tip>
-  -   All the following steps need the device to be online 
-  -   You can use the web ceiba to check the device's online status and the device's Serial No. 
-</note> 
  
 +  - 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
 +
 +</note>
  
 ===== Basic info ===== ===== Basic info =====
-  - Device Serial No.： 0089000EFD \\ + 
-  - Server address：http://IP:12056/ (IP and Port is the web ceiba used, the default port is 12056) \\ +  * API Guide: [[http://15.188.206.201:12056/basic/home/default.html| Ceiba2 API]] (Visible after login, username:APITEST_UK, password: APITEST_UK123456) 
-  - Login Username: username (Ceiba client login username) \\ +  * Device Serial No.： 0089000EFD 
-  - Login password: password (Ceiba client login password) \\ +  * Server address："http://IP:12056" (IP and Port is the web ceiba used, the default port is 12056)  
-  - KEY：zT908g2j9ng4xe0Nr2n1hbSblgS24wXjZV3o9wsVfNq0q3nEdl%2Fw%3D%3D (This key is a sample, do not use it in your code) \\ +  * Login Username: username (Ceiba client login username)  
-  - Demo url: http://IP:12056/h5demo/index.html (Visible after login) \\ +  * Login password: password (Ceiba client login password)  
-  - API help url：http://IP:12056/help/api/default.html (Visible after login) \\+  * KEY：zT908g2j9ng4xe0Nr2n1hbSblgS24wXjZV3o9wsVfNq0q3nEdl%2Fw%3D%3D (This key is a sample, do not use it in your code)  
 +  * Demo url: [[http://15.188.206.201:12056/h5demo/index.html|http://15.188.206.201:12056/h5demo/index.html]] (Visible after login)  
  
 ===== LiveView ===== ===== LiveView =====
Line 21: Line 25:
  
 Request URL: Request URL:
-    http://IP:12056/api/v1/basic/key?username=username&password=password+<code>
  
-Return:  +  http://IP:12056/api/v1/basic/key?username=username&password=password
-    {"data":{"key":"zT908g2j9ng4xe0Nr2n1hbSblgS24wXjZV3o9wsVfNq0q3nEdl%2Fw%3D%3D"},"errorcode":200}+
  
-**2. Get LiveView port**+</code> 
 + 
 +Return: 
 + 
 +<code> 
 +  {"data":{"key":"zT908g2j9ng4xe0Nr2n1hbSblgS24wXjZV3o9wsVfNq0q3nEdl%2Fw%3D%3D"},"errorcode":200} 
 + 
 +</code> 
 + 
 +**2. Get [[internal:draft:liveview|LiveView]] port**
  
 Request URL: Request URL:
-    http://IP:12056/api/v1/basic/live/port?key=zT908g2j9ng4xe0Nr2n1hbSblgS24wXjZV3o9wsVfNq0q3nEdl%2Fw%3D%3D+<code>
  
-Return:  +  http://IP:12056/api/v1/basic/live/port?key=zT908g2j9ng4xe0Nr2n1hbSblgS24wXjZV3o9wsVfNq0q3nEdl%2Fw%3D%3D
-    {"data":[{"port":12060},{"port":12061},{"port":12062},{"port":12063}],"errorcode":200}+
  
-**3. Get LiveView URL**+</code> 
 + 
 +Return: 
 + 
 +<code> 
 +  {"data":[{"port":12060},{"port":12061},{"port":12062},{"port":12063}],"errorcode":200} 
 + 
 +</code> 
 + 
 +**3. Get [[internal:draft:liveview|LiveView]] URL**
  
 Request URL: Request URL:
-    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> 
 + 
 +  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: Return:
-    {"data":{"url":"http://IP:12060/live.flv?devid=0089000EFD&chl=1&st=0&isaudio=1&dt=mdvr"},"errorcode":200}\\ 
  
-**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;+  {"data":{"url":"http://IP:12060/live.flv?devid=0089000EFD&chl=1&st=0&isaudio=1&dt=mdvr"},"errorcode":200}\\ 
 + 
 +</code> 
 + 
 +**4. Open the [[internal:draft:liveview|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 ===== ===== Playback =====
Line 51: Line 82:
  
 Request URL: Request URL:
-    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> 
 +  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: Return:
-    {"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} 
  
-**2. Get the playback URL** +<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: Request URL:
-    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> 
 +  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: Return:
-    {"data":{"url":"http://IP:8090/play/00880038EE/1/20190418001442_20190418001448_main.m3u8"},"errorcode":200}+ 
 +<code> 
 +  {"data":{"url":"http://IP:8090/play/00880038EE/1/20190418001442_20190418001448_main.m3u8"},"errorcode":200} 
 + 
 +</code>
  
 **3. Playback** **3. Playback**
-    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> 
 +  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>
  
  
  • public/ceiba2/api.1629998283.txt.gz
  • Last modified: 2021/08/26 19:18
  • by europe