API开发规范

  1. 关于滥用:
    以下这些,但并不限于以下这些行为都被视为滥用:
    • 短时间内大量访问API进行添加、修改、删除等操作。

    • 其它没有提到的,但会给系统带来压力的请求行为。

  2. 禁止登录:

    如果账号尝试登录错误次数在5分钟内超过30次则会被禁止登录一个小时,写程序的时候特别是动态客户端的时候必须判断是否登录成功。

  3. 关于封禁:

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

  4. 接口交互方式:

    数据交互方式:通过HTTP协议进行数据交互,即通过HTTP的POST请求响应方式,接口调用方通过发送带参数的请求URL,被调用方接收请求参数并执行业务,结束后将执行结果以纯文本形式返回给调用方。

  5. 请求方法:

    只支持POST方法请求数据,用其它方法会提示相关错误。

  6. 关于编码:

    请求URL字符编码:UTF-8,相应操作结果字符编码:UTF-8。

公共参数

所有的接口都需要这些参数,在此统一说明,下面的接口将不再列出。这些参数必须和接口参数一起提交。
  • token 密钥

通用返回

这些字段在所有的接口都有可能返回,,它们是所有接口共通的,在此统一说明,下面的接口将不再列出
名称 类型 说明
code int 执行成功与否, 1表示成功, 其他值则为错误代码
message string 返回说明
data array 返回数据数组

目录