WolfRecorder Wiki

User Tools

Site Tools

Trace: • api
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
api [2023/05/08 17:31]
nightfly 		api [2025/08/14 16:10] (current)
nightfly
Line 30: Line 30:
 |            | delete | cameraid | deletes specified camera | |            | delete | cameraid | deletes specified camera |
 |            | isregistered | ip    | checks is some camera is registered by IP on NVR or not? | |            | isregistered | ip    | checks is some camera is registered by IP on NVR or not? |
 +|            | isipportfree | ip+port   | checks is some camera IP+PORT free on NVR or not? |
 | users      | getall |      | returns array of all available users data | | users      | getall |      | returns array of all available users data |
 |            | create | login + password     | creates new limited user | |            | create | login + password     | creates new limited user |
Line 48: Line 49:
 |            | getscreenshotsall |      | returns array of all available channel screenshots | |            | getscreenshotsall |      | returns array of all available channel screenshots |
 |            | getscreenshot | channelid     | returns specified channel screenshot path | |            | getscreenshot | channelid     | returns specified channel screenshot path |
-|            | getlivestream | channelid     | returns live preview stream URL (not implemented yet) |+|            | getlivestream | channelid     | returns live preview stream URL |
 | recorders  | getall |      | returns array of all running cameras recorders processes | | recorders  | getall |      | returns array of all running cameras recorders processes |
 |            | isrunning | cameraid      | check is recorder running for some camera or not | |            | isrunning | cameraid      | check is recorder running for some camera or not |
Line 156: Line 157:
 ===== Storages states ===== ===== Storages states =====
  
 +**Request**
 +<code>
 +http://yourhost.com/wr/?module=remoteapi&key=WRxxxxxxxxxxxx&action=rest&storages=getstates
 +</code>
 +
 +**Reply**
 +<code>
 +Array
 +(
 +    [13] => Array
 +        (
 +            [state] => 1
 +            [total] => 968792403968
 +            [used] => 639428460544
 +            [free] => 329363943424
 +        )
 +
 +    [1] => Array
 +        (
 +            [state] => 1
 +            [total] => 31183237120
 +            [used] => 28042903552
 +            [free] => 3140333568
 +        )
 +
 +)
 +
 +</code>
 +
 +
 +
 +===== Existing cameras list =====
 +
 +
 +**Request**
 +<code>
 +http://yourhost.com/wr/?module=remoteapi&key=WRxxxxxxxxxxxx&action=rest&cameras=getall
 +</code>
 +
 +**Reply**
 +<code>
 +Array
 +(
 +    [54] => Array
 +        (
 +            [CAMERA] => Array
 +                (
 +                    [id] => 54
 +                    [modelid] => 11
 +                    [ip] => 172.30.1.92
 +                    [login] => admin
 +                    [password] => SomePassword
 +                    [active] => 1
 +                    [storageid] => 1
 +                    [channel] => kiqgdmrbma1
 +                    [comment] => Here some camera description
 +                    [realport] => Here is camera RTSP port that depends template or custom port if set
 +                    [maxretention] => Here is maximum retention days limit or zero if no
 +                )
 +
 +            [TEMPLATE] => Array
 +                (
 +                    [DEVICE] => Hikvision DS-2CD1023G0E-I
 +                    [PROTO] => rtsp
 +                    [MAIN_STREAM] => /h264
 +                    [SUB_STREAM] => /h264
 +                    [RTSP_PORT] => 554
 +                    [HTTP_PORT] => 80
 +                    [SOUND] => 0
 +                )
 +
 +            [STORAGE] => Array
 +                (
 +                    [id] => 1
 +                    [path] => /wrstorage
 +                    [name] => Default
 +                )
 +               
 +            [OPTS] => Array
 +                (
 +                    [id] => 1
 +                    [cameraid] => 57
 +                    [rtspport] => 666
 +                    [keepsubalive] => 0
 +                    [maxretdays] => 0
 +                    [order] => 
 +                )   
 +
 +        )
 +
 +    [33] => Array
 +        (
 +        ....
 +</code>
 +
 +
 +===== User creation =====
 +
 +**Request**
 +<code>
 +http://yourhost.com/wr/?module=remoteapi&key=WRxxxxxxxxxxxx&action=rest&users=create
 +</code>
 +
 +**Request data**
 +<code>
 +$requestData=array(
 + 'login'=>'view666',
 + 'password'=>'PasswordHere'
 + );
 +</code>
 +
 +**POST variable 'data'**
 +<code>
 +
 +{"login":"view666","password":"PasswordHere"}
 +</code>
 +
 +**Reply**
 +<code>
 +
 +
 +Array
 +(
 +    [error] => 0
 +    [message] => Success
 +)
 +</code>
 +
 +===== Attempt to create existing user =====
 +
 +**Request**
 +<code>
 +http://yourhost.com/wr/?module=remoteapi&key=WRxxxxxxxxxxxx&action=rest&users=create
 +</code>
 +
 +**Request data**
 +<code>
 +$requestData=array(
 + 'login'=>'view666',
 + 'password'=>'PasswordHere'
 + );
 +</code>
 +
 +**POST variable 'data'**
 +<code>
 +
 +{"login":"view666","password":"PasswordHere"}
 +</code>
 +
 +**Reply**
 +<code>
 +Array
 +(
 +    [error] => 7
 +    [message] => User already exists
 +)
 +</code>
 +
 +
 +We hope it is clear how it works. You can also check out a sample implementation of this API at [[https://github.com/nightflyza/Ubilling/blob/master/api/libs/api.wolfrecorder.php|this link]].
  
api.1683556272.txt.gz · Last modified: 2023/05/08 17:31 by nightfly

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki