HTTP制御API

HTTP 制 御 APIVersion 1.0ForC1002W /C1002RW

HTTP 制 御 API 仕 様 書目 次C1002 HTTP API Programming guide....................................................................................... 3snapshot.cgi ........................................................................................................................................... 5Videostream.cgi..................................................................................................................................... 6get_status.cgi ........................................................................................................................................ 7camera_control.cgi .............................................................................................................................. 8reboot.cgi ................................................................................................................................................ 8restore_factory.cgi ............................................................................................................................... 8get_params.cgi...................................................................................................................................... 9upgrade_firmware.cgi........................................................................................................................ 12upgrade_htmls.cgi.............................................................................................................................. 12set_alias.cgi ......................................................................................................................................... 12set_datetime.cgi.................................................................................................................................. 13set_users.cgi........................................................................................................................................ 13set_devices.cgi.................................................................................................................................... 14set_network.cgi ................................................................................................................................... 15set_wifi.cgi............................................................................................................................................ 16set_pppoe.cgi....................................................................................................................................... 16set_upnp.cgi......................................................................................................................................... 17set_ddns.cgi ......................................................................................................................................... 17set_ftp.cgi ............................................................................................................................................. 18set_mail.cgi .......................................................................................................................................... 18set_alarm.cgi ....................................................................................................................................... 1922008/09/27

HTTP 制 御 API 仕 様 書C1002 HTTP API Programming guideGeneral rule:CGI authentication: Three levels authorization required for different CGI command,Visitor, Operator, Administrator according to http Basic authenticationmechanism.Get or Post: Only GET & POST is supported. upgrade_firmware.cgi &upgrade_htmls.cgi only support POST, others support GET.Example:GET examplePOST exampleCGI return:According to return message, there are two categories CGI commandsCat.1: To obtain C1002 status and settings, will return status, and settings.get_status.cgi & get_params.cgiex.:var id=’003456789A0A’;var sys_ver=’0.0.1.2’;var app_ver=’0.0.1.3’;var alias=”;var now=1195552193;32008/09/27

HTTP 制 御 API 仕 様 書var tz=0;var ntp_enable=1;var ntp_svr=’time.nist.gov’;Cat.2: To control C1002, will return operation results. If success will return “ok”, iffailed will return ex.: “error: illegal param” to indicate wrong parameters given.If don’t want return “ok” after successful operation, can add next_url in CGIparameters to go to. The path used should be relative path.42008/09/27

HTTP 制 御 API 仕 様 書snapshot.cgiDescription : snapshotAuthorization : VisitorSyntax : /snapshot.cgi[?user=&pwd=&next_url=]Parameter:next_url : filenameuser: usernamepwd: passwordNote :If no next_url parameter,return filename will be:Device ID ( alias)_time.jpghttp://www.ipcamera.com.tw:8206/snapshot.cgi?next_url=a.jpgfilename a.jpg will gethttp://www.ipcamera.com.tw:8206/snapshot.cgiwill get 001E1A01002A(C1002)_19700101034208.jpg as filenamehttp://C1002_IP_Address/snapshot.cgi?user=admin&pwd=Username : adminPassword :(no password)Two Authentication approaches supported:1. http commands Basic authorization2. Embedded the username/password in http command line52008/09/27

HTTP 制 御 API 仕 様 書Videostream.cgiDescription : Server Push, push jpeg video stream to clientAuthorization : VisitorSyntax : /videostream.cgi[?user=&pwd=]Parameter:user: usernamepwd: passwordhttp://C1002_IP_Address/videostream.cgi?user=admin&pwd=Username : adminPassword :(no password)Two Authentication approaches supported:http commands Basic authorizationEmbedded the username/password in http command line62008/09/27

HTTP 制 御 API 仕 様 書get_status.cgiDescription : StatusAuthorization : VisitorSyntax : /get_status.cgiRetrun:now: Seconds from 1970-1-1 0:0:0 to present timealarm_status: 0: Disable; 1: Motion Detect; 2: Alarm inddns_status: ddns status0 Disable1 Connecting2 Failed3 DynDns Success4 DynDns fail: System error5 DynDns fail: Username or password error6 DynDns fail: Not Registered7 DynDns fail: Domail name error8 DynDns fail: Domain not exist9 DynDns fail: Domain is not yours10 DynDns fail: Too much (few) requests11 DynDns fail: Abused domain12 DynDns fail: DDNS Server error13 DynDns fail: No response from server14 Oray fail: No response from server15 Oray fail: Username or password error16 Oray fail: Domail name error17 Oray success18 Reserved19 Reserved20 Reserved21 Reservedupnp_status: upnp status0 Disable1 Success2 System error3 Network error4 Communication error5 Rejected, possible port conflicts72008/09/27

HTTP 制 御 API 仕 様 書camera_control.cgiDescription : SENSOR controlAuthorization : OperatorSyntax : /camera_control.cgi?param=&value=[&next_url=]Parameter:param:Parametervalue:valueparamvalue0: Resolution 8: qvga 320x24032: vga 640x4801: Brightness 0 ~ 2552: Contrast 0 ~ 63: Mode0: 50hz1: 60hz2: Outdoorreboot.cgiDescription : RebootAuthorization : AdministratorSyntax : /reboot.cgi[?next_url=]restore_factory.cgiDescription : Reset to factory defaultAuthorization : AdministratorSyntax : /restore_factory.cgi[?next_url=]82008/09/27

HTTP 制 御 API 仕 様 書alarm_mail0: Disable 1: Enable alarm emailalarm_upload_interval Alarm snapshots upload interval (secs); 0: Disable112008/09/27

HTTP 制 御 API 仕 様 書upgrade_firmware.cgiDescription : Upgrade FirmwareAuthorization : AdministratorSyntax : /upgrade_firmware.cgi[?next_url=]Remark: POST command.upgrade_htmls.cgiDescription : Upgrade WEB UIAuthorization : AdministratorSyntax : /upgrade_htmls.cgi[?next_url=]Remark: POST command.set_alias.cgiDescription : SET aliasAuthorization : AdministratorSyntax : /set_alias.cgi?alias=[&next_url=]Parameter:alias: alias

HTTP 制 御 API 仕 様 書set_datetime.cgiDescription : SET DATE & TIMEAuthorization : AdministratorSyntax : /set_datetime.cgi?tz=&ntp_enable=&ntp_svr=[&now=&next_url=]Parameter:nowSeconds from 1970-1-1 0:0:0 to present time, if followedparameter, set time according to parametertzTime zone difference from Greenwich time in secondsntp_enable Synchronize with NTP server, 0: Disable; 1: Enablentp_svrNTP server name

HTTP 制 御 API 仕 様 書set_devices.cgiDescription : SET multiple C1002 camerasAuthorization : AdministratorSyntax :/set_devices.cgi?dev2_alias=&dev2_host=&dev2_port=&dev2_user=&dev2_pwd=&dev3_alias=&dev3_host=&dev3_port=&dev3_user=&dev3_pwd=&dev4_alias=&dev4_host=&dev4_port=&dev4_user=&dev4_pwd=[&next_url=]Parameter:dev2_alias Channel 2 Alias < =20 charactersdev2_host Channel 2 IP Address < =64 charactersdev2_port Channel 2 portdev2_user Channel 2 Username < =12 charactersdev2_pwd Channel 2 Password < =12 characters…dev4_alias Channel 4 Alias < =20 charactersdev4_host Channel 4 IP Address < =64 charactersdev4_port Channel 4 portdev4_user Channel 4 Username < =12 charactersdev4_pwd Channel 4 Password < =12 characters142008/09/27

HTTP 制 御 API 仕 様 書set_network.cgiDescription : SET NETWORK ParametersAuthorization : AdministratorSyntax :/set_network.cgi?ip=&mask=&gateway=&dns=&port=[&next_url=]Parameter:ipmaskgatewaydnsportIpaddress, if blank, get by DHCP and ignoresubnet mask、gateway、dns set belowSubnet maskgatewayDns server ipport152008/09/27

HTTP 制 御 API 仕 様 書set_wifi.cgiDescription : SET Wi-Fi ParametersAuthorization : AdministratorSyntax :/set_wifi.cgi?enable=&ssid=&encrypt=&defkey=&key1=&key2=&key3=&key4=[&next_url=]Parameter:enable0: Disable wifi; 1 EnablessidWi-Fi ssid,

HTTP 制 御 API 仕 様 書set_upnp.cgiDescription : SET UPnP ParametersAuthorization : AdministratorSyntax :/set_upnp.cgi?enable=[&next_url=]Parameter:enable0: Disable upnp; 1: Enableset_ddns.cgiDescription : SET PPPoE ParametersAuthorization : AdministratorSyntax :/set_ddns.cgi?service=&user=&pwd=&host=&proxy_svr=&proxy_port=[&next_url=]Parameter:service0: Disable ddns service1: Oray2: DynDns.org (dyndns)3: DynDns.org (statdns)4: DynDns.org (custom)5: Reserved6: Reserved7: ReserveduserDDNS username

HTTP 制 御 API 仕 様 書set_ftp.cgiDescription : SET FTP ParametersAuthorization : AdministratorSyntax :/set_ftp.cgi?svr=&port=&user=&pwd=&mode=&dir=&upload_interval=[&next_url=]Parameter:svrftp server IP

HTTP 制 御 API 仕 様 書set_alarm.cgiDescription : SET ALARM ParametersAuthorization : AdministratorSyntax :/set_alarm.cgi?motion_armed=&input_armed=&iolinkage=&mail=&upload_interval=[&next_url=]Parameter:motion_armed 0: Disable 1: Enableinput_armed *1 0: Disable 1: Enableiolinkage *1 0: Disable 1: Enable alarm outmail0: Disable 1: Enable alarm emailupload_interval Alarm snapshots upload interval (0-65535 secs); 0:Disable*1 屋 外 用 モデルのみ 対 応192008/09/27