Differences

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

--- public:ceiba2:api [2021/08/26 18:45]
europe
+++ public:ceiba2:api [2021/09/20 18:27] (current)
europe
@@ Line 1: / Line 1: @@
-\\
+====== API Integration ======
- * Notice:
-     * \\
+<note tip>
-All the follow steps need the device to be online\\
-     * \\
-You can use the web ceiba to check the device' online status and device's Serial No.\\
- * \\
-Basic info：(IP and Port is the web ceiba used, the default port is 12056)
-     * \\
+  - All the following steps need the device to be online
-Device Serial No.： 0089000EFD\\
+  - 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
-Server address：http://IP:12056/\\
-     * \\
-Login username: username\\
-     * \\
-Logoin password: password\\
-     * \\
-KEY：zT908g2j9ng4xe0Nr2n1bvhbSblgS24wXjZV3o9wsVfNq0q3nEdl%2Fw%3D%3D\\
-     * \\
-Demo url: http://IP:12056/h5demo/index.html\\
-     * \\
-API help url：http://IP:12056/help/api/default.html
-\\
+</note>
-\\
-\\
- * \\
-LiveView:\\
- * \\
-Step1: Get key
-     * \\
+===== Basic info =====
-http://IP:12056/api/v1/basic/key?username=username&password=password\\
-     * \\
-Return:  {"data":{"key":"zT908g2j9ng4xe0Nr2n1bvhbSblgS24wXjZV3o9wsVfNq0q3nEdl%2Fw%3D%3D"},"errorcode":200}
-\\
+  * API Guide: [[http://15.188.206.201:12056/basic/home/default.html| Ceiba2 API]] (Visible after login, username:APITEST_UK, password: APITEST_UK123456)
-\\
+  * Device Serial No.： 0089000EFD
- * \\
+  * Server address："http://IP:12056" (IP and Port is the web ceiba used, the default port is 12056)
-Step2:  Get liveview port:
+  * 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://15.188.206.201:12056/h5demo/index.html|http://15.188.206.201:12056/h5demo/index.html]] (Visible after login)
-     * \\
-http://IP:12056/api/v1/basic/live/port?key=zT908g2j9ng4xe0Nr2n1bvhbSblgS24wXjZV3o9wsVfNq0q3nEdl%2Fw%3D%3D\\
-     * \\
-Return: {"data":[{"port":12060},{"port":12061},{"port":12062},{"port":12063}],"errorcode":200}
-\\
+===== LiveView =====
-\\
- * \\
-Step3: Get liveview url:
-\\
+**1. Get key**
-http://IP:12056/api/v1/basic/live/video?key=zT908g2j9ng4xe0Nr2n1bvhbSblgS24wXjZV3o9wsVfNq0q3nEdl%2Fw%3D%3D\\
-&terid=0089000EFD&chl=1&audio=1&st=0&port=12060&dt=mdvr\\
- * \\
-Return:{"data":{"url":"http://IP:12060/live.flv?devid=0089000EFD&chl=1&st=0&isaudio=1&dt=mdvr"},"errorcode":200}
-\\
+Request URL:
-\\
+<code>
- * \\
-Step4: Open demo and input the url to open the liveview;\\
- *
- \\
+  http://IP:12056/api/v1/basic/key?username=username&password=password
- *
- \\
+</code>
-\\
- * \\
-Playback:\\
- * \\
-Step 1, Search the record list:
-     * \\
+Return:
-http://IP:12056/api/v1/basic/record/filelist?key=zT908g2j9njDg2AqN6Dqx%2F94dwaNzZOGvJK1x%2FfQUZg%3D%20&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\\
-     * \\
-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}\\
- * \\
-Step 2, Get the playback url:
-     * \\
+<code>
-http://IP:12056/api/v1/basic/record/video?key=zT908g2j9njDg2AqN6Dqx%2F94dwaNzZOGvJK1x%2FfQUZg%3D&terid=00880038EE&starttime=2019-04-18%2000:14:42&endtime=2019-04-18%2000:14:48&chl=1\\
+  {"data":{"key":"zT908g2j9ng4xe0Nr2n1hbSblgS24wXjZV3o9wsVfNq0q3nEdl%2Fw%3D%3D"},"errorcode":200}
-     * \\
-Return:{"data":{"url":"http://IP:8090/play/00880038EE/1/20190418001442_20190418001448_main.m3u8"},"errorcode":200}\\
- * \\
-Step3, playback
-     * \\
+</code>
-Fill "http://IP:8090/play/00880038EE/1/20190418001442_20190418001448_main.m3u8" in the demo will be playback
+**2. Get [[internal:draft:liveview|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 [[internal:draft:liveview|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 [[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 =====
+**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>