API说明

  1. DNSPod 用户 API 仅限于个人用户使用,使用户能更方便、更灵活的管理自己的域名和记录。
  2. 域名注册商等代理用户请使用代理 API,申请成为代理用户请点击:https://www.dnspod.cn/Service#/account/agent
  3. 不允许任何第三方使用本 API 获取、操作用户数据,如有类似需求,欢迎联系合作。

API开发规范

  1. 关于滥用:
    包括但不限于以下情形都被视为滥用:
    • 短时间内大量添加、删除、修改、刷新域名或者记录,或者设置记录状态。
    • 记录内容没有任何改变的刷新,比如动态DNS中IP没变也请求修改记录。
    • 程序逻辑不严谨、程序死循环等等,可能造成大量无效、重复的请求。
    • 其它没有提到的,但会给系统带来压力的请求行为。

    为了保障您和广大开发者的利益,请您合理使用API,对于任何滥用API的行为,DNSPod有权对此进行封禁,并保留最终解释权。

  2. 禁止登录:

    如果帐号尝试登录错误次数在5分钟内超过30次则会被禁止登录一个小时,写程序的时候特别是动态客户端的时候必须判断是否登录成功,如果不成功必须马上停止尝试。如果使用动态客户端,在网页上修改了密码后务必到客户端修改,否则将不可用。

  3. 关于封禁:

    由于滥用API将会导致帐号在API中封禁,但并不影响在官方网站上的使用,封禁一定的时间后会自动解除,一般需要一个小时后才会解封,所以请小心操作,不要拿API进行大量测试。

  4. 关于请求:
    • 请求的地址为 https://dnsapi.cn/ 开头的地址,基于SSL安全传输。为了安全必须用https开头的地址,否则将有可能被封禁。
    • 只支持POST方法请求数据,用其它方法会提示错误。
    • 请用UTF-8编码进行数据传输,返回的数据也是UTF-8编码的。
  5. 关于UserAgent:
    • 请求的时候必须设置UserAgent,如果不设置或者设置为不合法的(比如设置为浏览器的)也会导致帐号被封禁API。
    • UserAgent的格式必须为:程序英文名称/版本(联系邮箱),比如:MJJ DDNS Client/1.0.0 (shallwedance@126.com)。
  6. 关于安全:

    用户需要输入用户邮箱和密码才能进行下一步的操作,如果需要在客户端上或数据库中保存用户的信息,必须加密后保存,不得明文保存在文件中。

  7. 技术支持:

公共参数

所有的接口都需要这些参数,在此统一说明,下面的接口将不再列出。这些参数必须和接口参数一起提交。
  • login_token 用于鉴权的 API Token
  • format {json,xml} 返回的数据格式,可选,默认为xml,建议用json
  • lang {en,cn} 返回的错误语言,可选,默认为en,建议用cn
  • error_on_empty {yes,no} 没有数据时是否返回错误,可选,默认为yes,建议用no
  • user_id 用户的ID,可选,仅代理接口需要, 用户接口不需要提交此参数
说明:
  • API Token 生成方法详见:https://support.dnspod.cn/Kb/showarticle/tsid/227/,完整的 API Token 是由 ID,Token 组合而成的,用英文的逗号分割
  • 为保证安全性,旧的 “用户名 + 密码” 的鉴权方式不再支持,开发者请使用 login_token 来完成鉴权

共通返回

这些返回在所有的接口都有可能返回,它们是所有接口共通的,在此统一说明,下面的接口将不再列出。另外,文档中的参考返回只列出JSON格式的,XML格式类似,就不再列出了。
  • -1 登陆失败
  • -2 API使用超出限制
  • -3 不是合法代理 (仅用于代理接口)
  • -4 不在代理名下 (仅用于代理接口)
  • -7 无权使用此接口
  • -8 登录失败次数过多,帐号被暂时封禁
  • 85 帐号异地登录,请求被拒绝
  • -99 此功能暂停开放,请稍候重试
  • 1 操作成功
  • 2 只允许POST方法
  • 3 未知错误
  • 6 用户ID错误 (仅用于代理接口)
  • 7 用户不在您名下 (仅用于代理接口)
  • 83 该帐户已经被锁定,无法进行任何操作
  • 85 该帐户开启了登录区域保护,当前IP不在允许的区域内

D令牌验证相关

对于已经开启D令牌的用户,在请求API时需要增加如下两个参数:
  • login_code D令牌生成的随机验证码,必选
  • login_remember {yes,no} 是否记住验证码,可选,默认为yes

说明:由于D令牌的随机码每30秒变换一次,所以建议用户在第一次请求API的时候选择记住验证码。选择记住验证码后,除了返回所请求的数据以外,还会发一个名为’t’ + user_id 的cookie,形如:t123456,该cookie的有效期为1个月,以后再请求API可以带上这个cookie,而无须再提交login_code和login_remember参数。

对于开启了D令牌的用户,某些重要操作可能会返回以下错误码,在此统一说明,下面的接口将不再列出。
  • 50 您开启了D令牌,需要验证码
  • 51 没有开启D令牌
  • 52 验证码不正确
  • 53 您已经开启了D令牌
  • 54 域名所有者开启了D令牌,您也需要开启D令牌才能管理该域名

获取API版本号

接口地址:
HTTP请求方式:
  • POST
请求参数:
  • 公共参数
响应代码:
  • 共通返回

示例:

curl -X POST https://dnsapi.cn/Info.Version -d 'login_token=LOGIN_TOKEN&format=json'

返回参考:

  • JSON:

    {
        "status": {
            "code": "1",
            "message": "4.6",
            "created_at": "2012-09-10 11:20:39"
        }
    }
    

Table Of Contents

Previous topic

DNSPod用户API文档

Next topic

帐户相关

This Page