用户工具

站点工具


帮助:api

差别

这里会显示出您选择的修订版和当前版本之间的差别。

到此差别页面的链接

后一修订版
前一修订版
帮助:api [2011/08/04 21:37]
refactor 创建
帮助:api [2013/03/04 13:22] (当前版本)
refactor [设备认证]
行 1: 行 1:
-====== ​小辣椒动态域名更新API ​======+====== ​公云(3322)动态域名更新API ​======
  
-通过小辣椒API,您可以很容易开发出动态域名客户端,或者将动态域名功能集成到自己的设备中。 +通过公云API,您可以很容易开发出动态域名客户端,或者将动态域名功能集成到自己的设备中。
- +
-任何小辣椒的账户,都可以使用动态域名API,如果您还没有注册小辣椒,请[[http://​www.3322.net/​accounts/​signup/​|点此]]注册。+
  
 +任何公云的账户,都可以使用动态域名API,如果您还没有注册公云,请[[http://​www.3322.net/​accounts/​signup/​|点此]]注册。
  
 ===== 介绍 ===== ===== 介绍 =====
行 22: 行 21:
 å®šæ—¶æ›´æ–°ï¼Œæ¯éš”一定时间,发起更新请求,注意两次间隔时间不能短于1分钟(收费用户不能短于15秒),如果连续3次以上频繁请求,该域名会被系统自动封堵,返回 abuse 代码。 å®šæ—¶æ›´æ–°ï¼Œæ¯éš”一定时间,发起更新请求,注意两次间隔时间不能短于1分钟(收费用户不能短于15秒),如果连续3次以上频繁请求,该域名会被系统自动封堵,返回 abuse 代码。
  
-  * IP的变化检测,可以采用 web 方式进行检测,客户端可以访问 http://​ip.3322.net 获取自己的IP,两次请求返回的IP变化了,就发起更新请求。注意访问 http://​ip.3322.net ​的两次间隔时间不能短于1分钟,如果连续3次以上频繁请求,该域名会被系统自动封堵+  * IP的变化检测,可以采用 web 方式进行检测,客户端可以访问 http://​ip.3322.net 获取自己的IP,两次请求返回的IP变化了,就发起更新请求。注意访问 http://​ip.3322.net ​的两次间隔时间不能短于1分钟,如果连续3次以上频繁请求,该IP会被系统自动封堵
  
   * 使用[[http://​www.ietf.org/​rfc/​rfc2617.txt|HTTP]]验证作为API的用户身份验证方式。   * 使用[[http://​www.ietf.org/​rfc/​rfc2617.txt|HTTP]]验证作为API的用户身份验证方式。
  
-  * User-Agent, ​代表客户端名称、版本,需要根据设备类型、名称、特征进行自定义,不要使用示范中的名称,否则可能被封堵+  * User-Agent, ​代表客户端名称、版本,需要根据设备类型、名称、特征进行自定义,一般包括设备的厂家、型号、firmware版本号。请不要使用示范中的名称,否则可能被封堵。
  
  
-===== åŠ¨æ€åŸŸåæ›´æ–°åè®® ​=====+===== åŠ¨æ€åŸŸåæ›´æ–°æŽ¥å£ ​=====
  
-==== HTTP请求 ​====+==== æŽ¥å£åœ°å€ ​==== 
 + 
 +**API URL** 
 + 
 +<​code>​ 
 +http://​members.3322.net/​dyndns/​update  
 +</​code>​ 
 + 
 +**HTTP请求**
  
 <​code>​ <​code>​
 GET /​dyndns/​update?​hostname=yourhost.ourdomain.ext&​myip=ipaddress&​wildcard=OFF&​mx=mail.exchanger.ext&​backmx=NO&​offline=NO HTTP/1.1 GET /​dyndns/​update?​hostname=yourhost.ourdomain.ext&​myip=ipaddress&​wildcard=OFF&​mx=mail.exchanger.ext&​backmx=NO&​offline=NO HTTP/1.1
-Host: members.3322.org+Host: members.3322.net
 Authorization:​ Basic username:​password Authorization:​ Basic username:​password
 User-Agent: myclient/​1.0 me@null.net User-Agent: myclient/​1.0 me@null.net
行 67: 行 74:
 è¯¥å‚数可选,​ 使域名暂时失效。 è¯¥å‚数可选,​ 使域名暂时失效。
  
 +==== HTTP状态返回码 ====
 +HTTP状态返回码为200、4XX、5XX,其中4XX表示认证错误,500表示服务器内部出错,200表示正常请求。但是动态域名客户端
 +请忽略HTTP返回码,而是对下面的返回值进行解析。比如返回值"​interror"​表示内部出错,这时对应的HTTP状态返回码是500。
  
 ==== 返回值 ==== ==== 返回值 ====
行 93: 行 103:
  
   * notfqdn   * notfqdn
-没有提供域名参数,必须提供一个在小辣椒注册的动态域名域名。+没有提供域名参数,必须提供一个在公云注册的动态域名域名。
  
   * nohost   * nohost
行 105: 行 115:
  
   * !active   * !active
-该域名被系统关闭,请联系小辣椒客服人员。+该域名被系统关闭,请联系公云客服人员。
  
   * abuse   * abuse
-该域名由于段时间大量发送更新请求,被系统禁止,请联系小辣椒客服人员。+该域名由于段时间大量发送更新请求,被系统禁止,请联系公云客服人员。 
 + 
 +=== 服务器出错 ===
  
   * dnserr   * dnserr
-DNS æœåŠ¡å™¨æ›´æ–°å¤±è´¥+DNS æœåŠ¡å™¨æ›´æ–°å¤±è´¥ã€‚ 
 + 
 +  * interror 
 +服务器内部严重错误,比如数据库出错或者DNS服务器出错。 
 + 
 +===== 获取IP接口 ===== 
 + 
 + 
 +客户端可以通过该接口获取自己的IP,用于客户端检测IP的变化。 
 + 
 +注意访问 http://​ip.3322.net 的两次间隔时间不能短于1分钟,如果连续3次以上频繁请求,该IP会被系统自动封堵 
 + 
 + 
 +==== 接口地址 ==== 
 + 
 +**API URL** 
 + 
 +<​code>​ 
 +http://​ip.3322.net  
 +</​code>​ 
 + 
 +==== 参数说明 ==== 
 +无 
 + 
 +==== 返回值 ==== 
 + 
 +客户端的IP地址 
 + 
 + 
 +===== 常见问题 ===== 
 + 
 +  * 没有对请求做事务处理,没有检查服务器的返回值,没有判断域名更新是否成功 
 +  * 更新失败以后,没有记录日志,没有进行延时、重试的过程 
 +  * 请求过于频繁,导致域名被服务器封杀 
 +  * 客户端使用实例的名字,没有根据自己设备的类型、名称、特征进行自定义 
 + 
 + 
 +===== 设备认证 ===== 
 + 
 + 
 +公云(3322)动态域名更新API简单易用,方便了开发者和集成商开发自己的客户端,给设备增加动态域名功能。 
 + 
 +但是如果对客户端的理解不深入,会产生一些错误或者更新失败,导致动态域名更新失败,用户无法通过域名访问设备。 
 + 
 +公云为了规范域名的更新流程,保障设备的正常工作,对市场上使用公云动态域名更新API的设备进行认证: 
 + 
 +  * 由公云的工程师,对设备进行认真,全面的测试,保证设备能够在各种网络条件、各种异常条件下正常更新域名 
 +  * 提供认证的设备清单,推荐公云的广大用户选用
  
 +设备认证的具体方法,请参见[[帮助:​设备认证|设备认证]]
帮助/api.1312465024.txt.gz · 最后更改: 2011/08/04 21:37 由 refactor