JVC 137, 257VP, 237VP, VN-H57, 157WP Using API that Requires Basic Authentication, Procedure

Page 18

waits 0-0.7 second before sending response to avoid too many responses are sent in short period from many cameras.

Response Example

system.id=VN-H37(192.168.0.2/24)&200 OK<CRLF>

7. Using API that Requires Basic Authentication

Basic authentication is required for JVC API explained in Section 7 or later. This section provides general explanation of those APIs.

7.1.Procedure

1)The client establishes a TCP connection to port number 80.

2)The client sends API.

API has following structure.

GET

space

API Characters

space

HTTP/1.1

0x0D 0x0A

Accept:

space

text/plain (or text/html)

0x0D 0x0A

Host:

space

IP Address of Camera

0x0D 0x0A

Authorization: Basic

space

Encoded User Name and Password

0x0D 0x0A 0x0D 0x0A

The following is an example of API for Getting subnet mask of the camera.

Example

GET /api/param?network.interface.subnetmask HTTP/1.1<CRLF>

Accept: text/plain<CRLF>

Host: 192.168.0.2<CRLF>

Authorization: Basic YWRtaW46anZj<CRLF><CRLF>

Specify the response format by Accept line. Plain text response is returned when this is specified as text/plain. HTML response is returned when text/html is specified. HTML response is returned when Accept is not specified. These APIs for getting/setting parameters are protected by basic authentication. Authorization line needs to include encoded username and password. There are 3 types of usernames, namely admin, operator and user. Available APIs are different for each username. Join the user name and the password using a colon, Base64 encode this character string and enter this in the Authorization line.

For example, when

User name admin

Password jvc

then the character string joining the user name and the password with a colon is:

18

Image 18

Contents VN-H37/137/237/237VP VN-H57/157WP/257/257VP Updates Page Preface JVC API for Alarm FAQ Basic Procedures Streaming ProtocolJVC Protocol Jpeg Streaming API Format Structure Parameter DescriptionResponse RestrictionsJpeg File Format Sent Out by the camera FFD9JVC Protocol H.264 Streaming When API is successfully received H.264 Stream Format Send Out by the cameraExample of H.264 Stream JVC Protocol MPEG-4 Streaming MPEG-4 Stream Format Send Out by the camera Example of MPEG-4 Stream Jpeg API to Search CameraURI H.264Using API that Requires Basic Authentication ProcedureResponse Example System.id=VN-H37192.168.0.2/24&200 Okcrlf Api/param?ParamA.ParamB.ParamC&ParamA.ParamD.ParamE Getting ParameterApi/param?ParamA.ParamB.ParamC ParamA.ParamB.ParamC=Data&200 OKSetting Parameter JVC API for CameraGetting Camera ID Getting Current Scene File Number Setting Camera IDExample of setting /api/param?camera.id=Camera01 As follows. /api/param?camera.id=Comment%20In%20JPEGGetting Preset Data of Scene File Loading/Saving/Initializing Scene FileGetting Current Scene File Name Getting Auto Exposure Reference of a Scene File Setting Auto Exposure Reference of a Scene FileSetting Color Level of a Scene File Getting Color Level of a Scene FileGetting Enhance of a Scene File Setting Enhance of a Scene FileSetting 3DDNR of a Scene File Getting 3DDNR of a Scene FileGetting R-Gain of White Balance of a Scene File Setting White Balance of a Scene FileSetting R-Gain of White Balance of a Scene File Getting B-Gain of White Balance of a Scene FileSetting Limit of Sense Up of a Scene File Setting B-Gain of White Balance of a Scene FileSetting AGC of a Scene File Getting AGC of a Scene FileGetting ALC priority of Scene File Setting ALC priority of Scene FileSetting Shutter Speed of a Scene File Getting Shutter Speed of a Scene FilePage Getting Back Light Compensation of a Scene File Setting Back Light Compensation of a Scene FileSetting Clvi of a Scene File Getting Clvi of a Scene FileJVC API for Encode Setting Compression FormatGetting Resolution Frame Size Getting Compression FormatSetting Resolution Frame Size Getting Rate Control SettingSetting Rate Control Setting Jpeg File Size Setting H.264 or MPEG-4 bitrateGetting Jpeg File Size Setting Getting H.264 or MPEG-4 I-Frame Interval SettingSetting Frame Rate Setting H.264 or MPEG-4 I-Frame IntervalGetting Frame Rate Setting Setting Monitor Out StatusSetting Mike Gain Getting Audio Duplex ModeSetting Audio Duplex Mode JVC API for Audio VN-H57/157WP/257/257VPSetting Mike Power Supply JVC API for AlarmGetting Mike Power Supply setting Getting On/Off of Alarm ActionApi/param?application.event1.action Example of Response Getting Alarm ActionFormat /api/param?application.eventNumber.action Example of Response application.event1.action=&200 OKReturned. Segments are indicated by Setting Alarm Action Setting ExampleFormat /api/param?application.eventNumber.action=Data To add JPEG, specify objectNumber instead of none Getting Alarm Filter Setting Setting Alarm FilterGetting Alarm Filter Time Setting Alarm Filter TimeGetting Alarm Filter Type Setting Alarm Filter TypeFormat /api/param?application.eventNumber.trigger Getting Alarm TriggerSetting Alarm Trigger Format /api/param?application.eventNumber.trigger=dataJVC API for Alarm Environment Setting Example /api/param?application.event1.trigger=v1Setting Example /api/param?application.event6.trigger=i1500 Getting Smtp Server Port Number Setting Getting Smtp Server Address SettingSetting Smtp Server Address Setting Smtp Server Port NumberSetting POP before Smtp Setting Sender Mail AddressGetting POP before Smtp Setting Getting POP Server Address SettingSetting POP Server Port Number Setting POP Server AddressGetting POP Server Port Number Setting Getting POP Server User Name SettingSetting FTP Server Address Setting POP Server PasswordGetting FTP Server Address Setting Example of Response application.pop.user&200 OKGetting FTP Server User Name Setting Getting FTP Server Path SettingSetting FTP Server Path Setting FTP Server User NameApi/param?application.ftp.password=%00 Setting FTP Server PasswordSetting File Naming of Periodic FTP Getting File Naming of Periodic FTPSetting User Define Name of File Naming Getting User Define Name of File NamingGetting Parameters of Pre/Post Recording for FTP Setting Parameters of Pre/Post Recording for FTP JVC API for SD Card RecordGetting SD Card Status Getting Status of SD Card formatting Setting SD Card to Use/DisableSetting SD Card Constant Recording On/Off Formatting SD CardGetting SD Card Recording Status Setting Encoder No. for SD Card RecordingGetting SD Card Capacity Getting Encoder No. for SD Card RecordingGetting Auto Return Mode Setting Auto Return ModeJVC API for Digital PTZ Setting Auto Return Status Getting Timeout of Auto ReturnSetting Timeout of Auto Return Getting Speed of Going to Preset PositionGetting Pan Position Setting Speed of Going to Preset PositionSetting Direction of Pan Operation Moving to Specified Pan PositionGetting Tilt Position Setting Speed of Pan OperationGetting Pan Operation Status Moving to Specified Tilt PositionGetting Tilt Operation Status Setting Direction of Tilt OperationSetting Speed of Tilt Operation Getting Zoom PositionZoom Operation Setting Direction of Zoom OperationSetting Speed of Zoom Operation Getting Zoom Operation StatusRegister Current Position as Preset Position Getting Current Preset PositionGetting Status of Specified Preset Position Initialize Preset PositionJVC API for Auto Patrol Setting Duarion of Auto Patrol Getting Preset Postion Number of Auto PatrolSetting Preset Postion Number of Auto Patrol Getting Duration of Auto PatrolJVC API for Privacy Masking Setting Speed of Auto PatrolSaving Preset Position Number/Duarion of Auto Patrol Getting Speed of Auto PatrolGetting Privacy Masking Color Setting Privacy Masking to On/OffSetting Privacy Masking Color Getting Privacy Masking AreaSetting Motion Detect to On/Off Setting Motion Detect SensitivityGetting Motion Detect Sensitivity Setting Motion Detect Mask JVC API for Tampering DetectGetting Motion Detect Mask Getting Tampering Detect On/Off Status Setting Tampering Detect to On/OffSetting Tampering Detect Sensitivity Getting Tampering Detect SensitivitySetting Dhcp Enabling Network Setting ChangesGetting Dhcp Setting Allowed user adminGetting Default Gateway Setting IP AddressSetting Subnet Mask Getting IP AddressSetting DNS Server Status to On/Off, or Validate Changes Setting Default GatewaySetting Host Name Getting Host NameGetting DNS Server IP Address Setting DNS Server IP AddressSetting IPv6 status Getting IPv6 statusGetting MAC Address Setting TOS Value of StreamGetting Global Address of IPv6 Getting TOS Value of StreamGetting Unicast TTL Value Setting Unicast TTLSetting Multicast TTL Getting Multicast TTL ValueSetting Network Negotiation Setting MTU ValueGetting Network Negotiation Setting JVC API for ProtocolSetting Status of Psia Protocol Setting Port Number of HttpSetting Status of AMX Discovery Protocol Getting Status of AMX Discovery ProtocolJVC API for Multicast Streaming Setting Status of Onvif ProtocolSetting Status of Multicast Streaming, or Save Changes Getting Status of Onvif ProtocolGetting Multicast Address Setting Multicast AddressSetting Multicast Port Number Getting Multicast Port NumberSetting Frame Rate of Jpeg Multicast Getting Status of Audio Multicast StreamingGetting Audio Multicast Address Setting Audio Multicast Port Number JVC API for Access RestrictionsSetting Audio Multicast Address Getting Deny/Allow Setting of Client RestrictionsSetting IP Address of Restricted Client Setting Client Restriction to Deny/AllowGetting IP Address Setting of Restricted Client Format /api/param?network.accesscontrolstreamout.hostNumberJVC API for Time Setting On/Off of Sntp Client, or Validate ChangesSetting NTP Server Address Getting On/Off of Sntp ClientGetting Access Interval Unit of NTP Getting Access Interval to NTP ServerSetting Access Interval to NTP Server Setting Access Interval Unit of SntpSetting Time Getting TimezoneSetting Password of admin JVC API for PasswordSetting Timezone Format /api/param?system.password.adminnum=data2Setting Password of user JVC API for MaintenanceSetting Password of operator Delete AcountJVC API for LED Setting JVC API for Getting Status Getting LED blinking modeSetting LED blinking mode Getting Sending StatusGetting Model Name Alarm input 1ch makeGetting Log Format /api/param?system.logJVC API for Others Getting Alarm Input Status VN-H57/157/257Getting Mode of FTP Server Getting Firmware RevisionsSetting Port Number of Rtsp Server Setting Mode of FTP ServerSetting Control Port Number of FTP Server Getting Control Port Number of FTP ServerExample /api/param?network.rtsp.port=554 Camera Response When API is successfully received Sending Audio to the Camera VN-H57/157WP/257/257VPProcedures CameraGetting SD Card data from the Camera via RTSP/RTP Playback controlExample of message sequence Exporting H.264 data from SD Card to the PC Getting Total Number of Files and File Size1fCRLF Exporting SD Card Data as a File List of ActiveX List of Protocols and Port Numbers UsedCustomizing Built-in Viewer Protocol / Port Number UseHow to download ActiveX controls Properties of ActiveX102 How to use ActiveX Control by Html Method of ActiveX ControlDirection Number of n Html Sample Sample code105 106 107 FAQ Psia