API v2. Conventions. Security Parameters. Collections. HTTP codes. Security Roles. Docs» API v2

Transcription

1 Docs» API v2 API v2 Conventions Security Parameters headers X-Vsaas-Apikey (string) : Watcher API Key X-Vsaas-Session (string) : Session key, for logged in users Collections query search (string): Substring to filter collec on items (generally by name, tle and comment) limit (integer): Number of items returned (for collec ons) offset (integer): Number of skipped items (for collec ons) headers X-Page-Limit (integer) X-Page-Offset (integer) HTTP codes 200 Success 400 Valida onerror 400 BadRequest 403 Forbidden 403 ApikeyExpired 403 WrongApikey 404 NotFound 500 Applica onerror Security Roles guest authen cated user administrator Resource Opera on Desc

2 Resource Opera on Desc POST /vsaas/api/v2/agents/(string:agent_id)/reboot POST /vsaas/api/v2/agents/(string:agent_id)/reset GET /vsaas/api/v2/agents/(string:agent_id) GET /vsaas/sta c/(path:filename) Authen ca on POST /vsaas/api/v2/auth/generate-autologin-token POST /vsaas/api/v2/auth/forgot-password POST /vsaas/api/v2/auth/check-login GET /vsaas/api/v2/auth/whoami POST /vsaas/api/v2/auth/login Cameras POST /vsaas/api/v2/cameras GET /vsaas/api/v2/cameras Group Cameras POST /vsaas/api/v2/groups/(int:group_id)/cameras/(path:name)/order PUT /vsaas/api/v2/groups/(int:group_id)/cameras/(path:name) DELETE /vsaas/api/v2/groups/(int:group_id)/cameras/(path:name) POST /vsaas/api/v2/groups/(int:group_id)/cameras GET /vsaas/api/v2/groups/(int:group_id)/cameras Group Users PUT /vsaas/api/v2/groups/(int:group_id)/users/(int:user_id) DELETE /vsaas/api/v2/groups/(int:group_id)/users/(int:user_id) POST /vsaas/api/v2/groups/(int:group_id)/users Groups POST /vsaas/api/v2/groups GET /vsaas/api/v2/groups PUT /vsaas/api/v2/groups/(int:id) DELETE /vsaas/api/v2/groups/(int:id) GET /vsaas/api/v2/groups/(int:id) Users POST /vsaas/api/v2/users GET /vsaas/api/v2/users PUT /vsaas/api/v2/users/(int:id) DELETE /vsaas/api/v2/users/(int:id) GET /vsaas/api/v2/users/(int:id)

3 Authentication POST /vsaas/api/v2/auth/generate-autologin-token Generates an autologin token Used as an integra on point with a custom service Request JSON Object: login (string) life me (integer) valid_ ll (integer) Response JSON Object: autologin_token (string) POST /vsaas/api/v2/auth/forgot-password Sends an contains password reset URL Request JSON Object: login (string) User s login (op onal) (string) User s no fica on (op onal) Status Codes: 200 OK sent 403 Forbidden Login or not found POST /vsaas/api/v2/auth/check-login Checks user login and password Request JSON Object: login (string) User login password (string) User password Status Codes: 200 OK login and password are correct 403 Forbidden user does not exist or password is incorrect GET /vsaas/api/v2/auth/whoami Returns session informa on Request Headers: X-Vsaas-Session string session key, op onal

4 Response JSON Object: login (string) current login is_admin (boolean) current user can manage cameras, users, and groups POST /vsaas/api/v2/auth/login Logs user in Request JSON Object: login (string) User login password (string) User password Response JSON Object: session (string) SessionId login (bool) is_admin (bool) no fica on_ (bool) Camera Management POST /vsaas/api/v2/cameras Adds or modifies exis ng cameras Request Headers: Content-Type application/json or text/csv Request JSON Object Array: name (string): Stream iden fier access (enum) public authorized private agent_id (string) agent_key (string) agent_model (string) agent_pin (string) agent_serial (string) agent_status (object) connected_at (string) id (string) ip (string) local_ip (string) streampoint (string) version (string)

5 coordinates (string) dvr_depth (integer) dvr_ dvr_path (string) favorite (string) groups (object array) id (string) mo on_detector (boolean) onvif_profile (string) onvif_ptz (boolean) onvif_url (string) owner (string) permissions (string) playback_config (object) token (string) postal_address (string) preview_url (string) server (string) sta c (boolean) stream_status (object) alive (boolean) bitrate (integer) life me (integer) server (string) source_error (string) stream_url (string) substream_url (string) thumbnails (boolean) thumbnails_url (string) : Human readable tle GET /vsaas/api/v2/cameras Returns camera list Request JSON Object Array: name (string): Stream iden fier access (enum) public authorized private agent_id (string) agent_key (string)

6 agent_model (string) agent_pin (string) agent_serial (string) agent_status (object) connected_at (string) id (string) ip (string) local_ip (string) streampoint (string) version (string) coordinates (string) dvr_depth (integer) dvr_ dvr_path (string) favorite (string) groups (object array) id (string) mo on_detector (boolean) onvif_profile (string) onvif_ptz (boolean) onvif_url (string) owner (string) permissions (string) playback_config (object) token (string) postal_address (string) preview_url (string) server (string) sta c (boolean) stream_status (object) alive (boolean) bitrate (integer) life me (integer) server (string) source_error (string) stream_url (string) substream_url (string) thumbnails (boolean) thumbnails_url (string) : Human readable tle

7 POST /vsaas/api/v2/cameras/(path: name)/ptz/stop POST /vsaas/api/v2/cameras/(path: name)/ptz/move GET /vsaas/api/v2/cameras/(path: name)/agent User Management POST /vsaas/api/v2/users Adds user or users Request Headers: Content-Type application/json or text/csv Request JSON Object:

8 login (string) authorized_ip (string) camera_count (string) dvr_allowed (boolean) external_id (string) groups (object array) group_ can_dvr (boolean) can_manage_cameras (boolean) can_manage_users (boolean) can_ptz (boolean) group (object) usergroup_ is_admin (boolean) no fica on_ (string) password (string) GET /vsaas/api/v2/users Returns a user list Response JSON Object Array:

9 login (string) authorized_ip (string) camera_count (string) dvr_allowed (boolean) external_id (string) groups (object array) group_ can_dvr (boolean) can_manage_cameras (boolean) can_manage_users (boolean) can_ptz (boolean) group (object) usergroup_ is_admin (boolean) no fica on_ (string) password (string) PUT /vsaas/api/v2/users/(int: id) Modifies user User iden fier Request JSON Object Array:

10 login (string) authorized_ip (string) dvr_allowed (boolean) external_id (string) is_admin (boolean) no fica on_ (string) password (string) Response JSON Object Array: login (string) authorized_ip (string) dvr_allowed (boolean) external_id (string) is_admin (boolean) no fica on_ (string) password (string) DELETE /vsaas/api/v2/users/(int: id) Removes user User iden fier GET /vsaas/api/v2/users/(int: id) Returns a single user User iden fier Response JSON Object:

11 login (string) authorized_ip (string) camera_count (string) dvr_allowed (boolean) external_id (string) groups (object array) group_ can_dvr (boolean) can_manage_cameras (boolean) can_manage_users (boolean) can_ptz (boolean) group (object) usergroup_ is_admin (boolean) no fica on_ (string) password (string) Group Management POST /vsaas/api/v2/groups Creates group or groups Request JSON Object Array: Response JSON Object Array:

12 GET /vsaas/api/v2/groups Returns a group Response JSON Object Array: camera_count (integer) user_count (integer) POST /vsaas/api/v2/groups/(int: group_id)/cameras/(path: name)/order Modifies camera s posi on inside a group group_ Group iden fier name (integer) Camera name PUT /vsaas/api/v2/groups/(int: group_id)/cameras/(path: name) Modifies camera s parameters inside a group group_ Group iden fier name (integer) Camera name DELETE /vsaas/api/v2/groups/(int: group_id)/cameras/(path: name) Removes camera from group group_ Group iden fier name (integer) Camera name PUT /vsaas/api/v2/groups/(int: group_id)/users/(int: user_id) Modifies user s permissions inside a group group_ Group iden fier user_ User iden fier

13 Request JSON Object: group_ user_ can_dvr (boolean) can_manage_cameras (boolean) can_manage_users (boolean) can_ptz (boolean) Response JSON Object: group_ user_ can_dvr (boolean) can_manage_cameras (boolean) can_manage_users (boolean) can_ptz (boolean) group (object) user (object) login (string) dvr_allowed (boolean) is_admin (boolean) usergroup_ DELETE /vsaas/api/v2/groups/(int: group_id)/users/(int: user_id) Removes user from group group_ Group iden fier user_ User iden fier POST /vsaas/api/v2/groups/(int: group_id)/cameras

14 Adds camera to group group_id (string) Group iden fier Request JSON Object: camera_id (string) Camera name Response JSON Object: camera_id (string) group_ camera (object) name (string): Stream iden fier access (enum) public authorized private agent_id (string) agent_key (string) agent_model (string) agent_pin (string) agent_serial (string) coordinates (string) dvr_depth (integer) dvr_ dvr_path (string) mo on_detector (boolean) onvif_profile (string) onvif_ptz (boolean) onvif_url (string) owner (string) postal_address (string) preview_url (string) server (string) sta c (boolean) stream_url (string) substream_url (string) thumbnails (boolean) thumbnails_url (string) : Human readable tle

15 GET /vsaas/api/v2/groups/(int: group_id)/cameras Returns cameras belonging to the group Response JSON Object: camera_id (string) group_ camera (object) name (string): Stream iden fier access (enum) public authorized private agent_id (string) agent_key (string) agent_model (string) agent_pin (string) agent_serial (string) coordinates (string) dvr_depth (integer) dvr_ dvr_path (string) mo on_detector (boolean) onvif_profile (string) onvif_ptz (boolean) onvif_url (string) owner (string) postal_address (string) preview_url (string) server (string) sta c (boolean) stream_url (string) substream_url (string) thumbnails (boolean) thumbnails_url (string) : Human readable tle POST /vsaas/api/v2/groups/(int: group_id)/users Adds user to group

16 id (string) Group iden fier Request JSON Object: group_ user_ can_dvr (boolean) can_manage_cameras (boolean) can_manage_users (boolean) can_ptz (boolean) Response JSON Object: group_ user_ can_dvr (boolean) can_manage_cameras (boolean) can_manage_users (boolean) can_ptz (boolean) group (object) user (object) login (string) dvr_allowed (boolean) is_admin (boolean) usergroup_ PUT /vsaas/api/v2/groups/(int: id) Modifies a group id (string) Group fden fier Response JSON Object Array:

17 DELETE /vsaas/api/v2/groups/(int: id) Deletes a group id (string) Group iden fier GET /vsaas/api/v2/groups/(int: id) Returns a group list Response JSON Object Array: camera_count (integer) users (object array) group_ user_ can_dvr (boolean) can_manage_cameras (boolean) can_manage_users (boolean) can_ptz (boolean) user (object) login (string) dvr_allowed (boolean) is_admin (boolean) usergroup_