«
总览 API请求文档说明

时间:2021-9-9    作者:admin    分类: api接口文档


各种API说明,所有返回参数均是标准的json字符串,注:带*号的是必须携带的参数

通用返回参数说明:

    json:{
        code:0, 为0表示操作正确,响应正确,具体的错误码对照表见这:http://www.zoodt.cn/post-5.html
        msg:'success',success 表示操作正确,否则是错误信息
        result:null 如果有数据,这里是返回的数据,否则为null
                    如果请求列表数据,会返回两个键,一个是data,一个是rows,data是数据,rows是总条数
    }

所有请求,header 必须携带 substr(md5('x-app-id'),0,10) 的值为 APPID

比如一健安平要请求某个接口,header['4a1d62ea92'] = 'yijiananping'
4a1d62ea92 为substr(md5('x-app-id'),0,10) 的值。
yijiananping 为请求的应用id

关于拉取信息时的分页说明:

    拉取信息列表时,都是GET请求,携带参数limit,将表示本次拉取多少条,默认10条。
    携带参数page,将表示从第几页开始拉取,默认从第一页开始。

未归类的API请求:

    注册时获取手机号验证码:GET /v1/user/code.htm 目前没有做限制,限制都跟随腾讯云那边的
                    要求参数:phone * #手机号,且格式必须符合手机号格式
                    返回参数:正确或错误的通用返回
    登陆时获取手机号验证码:GET /v1/user/login_code.htm 目前没有限制,限制都是跟随腾讯那边的
                    要求参数同注册时一样。
    获取当前的系统配置信息:GET /v1/config.htm
                    要求参数:无
                    返回参数:id:唯一自增ID
                             name:唯一标识 强制要求必须是小写字母
                             value:该配置的值(所有开关类型的值,必须是y或n)
                             cn_name:在后台配置时的显示名称
                             desc:简单说明,供在后台配置时查看
                             data_type:该配置的类型,类型包括:input(常规输入框),input-sm(输入框,适合数值类型),switch(开关,值必须是y或n),textarea(常文本)
                             app_id:当前应用ID,用户应用ID为:user
                    有可视化操作界面且已开发完必,不在这里公示,需要的话联系我
    新增一个配置:POST /v1/config/add.htm
                要求参数:name * #唯一标识 强制要求必须是小写字母
                         cn_name * #在后台配置时的显示名称 建议中文
                         value * #该配置的值。
                         data_type * #该配置的类型,要求见上面返回参数里的描述
                         ......其它参数可参考返回参数,都是可选项

其它文档:

用户中心相关(/v1/center路径下的API请求文档) http://www.zoodt.cn/post-6.html

用户组相关(/v1/group路径下的API请求文档) http://www.zoodt.cn/post-10.html

用户资产(/v1/worth路径下的请求文档) http://www.zoodt.cn/post-14.html

话题相关API请求文档(/v1/chat路径下) http://www.zoodt.cn/post-12.html

注意:如果有新的API,也会更新此文档