«
用户中心API接口文档说明(/v1/center路径下)

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


请求 /v1/center/ 路径下的所有URL(含)或者要求是登录状态下,均需要在header里携带 substr(md5(x-user-id),0,10)(md5后的x-user-id的前10位),值为登录或注册时 服务器返回的id字段

md5后的x-user-id,取前10位的值是762146b1

用户相关(如果你能看懂PHP源码,可以去 https://gitee.com/maxzon/user/tree/master/App/HttpController/V1 查看所有请求API源码)

注册 POST /v1/user/reg.htm
要求参数:phone:int * #手机号 必须符合手机号格式
                code:string * #手机接收到的验证码
                user_uniq_id:string #用户的唯一字符串ID,如果不携带,后台自动生成
返回参数:返回上面的参数,再加上注册成功后经过加密的用户唯一自增ID,字段为:id

登录 POST /v1/user/login.htm
要求参数:phone:int * #手机号 必须符合手机号格式
                type:string * #登录格式,如果值为code的话,必须携带code参数
                code:string #手机验证码 如果上面的type值为code的话,此参数必须携带
                pwd:string #密码,如果type的值不为code,此参数必须携带
返回参数:id 加密后的用户唯一自增id
         user_uniq_id 用户固定唯一ID
         name 用户名
         create_time 注册时间 unix时间戳 13位 整型
         avatar 用户头像url地址
         last_active_time 用户最后活动时间
         last_active_ip 用户最后活动ip地址(通常是最近一次打开APP的是时间) 如 12.12.25.32
         is_report 值为y或n,是否接受应用推送的通知,y为是,n为否
         id_no 用户身份证号
         reg_ip 用户注册时的ip地址 如 203.1.25.1
         reg_location 用户注册时的经纬度 如:318.265212,25.2358 或为 0

注册或登陆(如果用户没有注册将自动注册) POST /v1/user/login_or_reg.htm
    要求参数:phone:int *#手机号
                    code:string *# 手机收到的验证码
                    说明:该验证码是验证从 /v1/user/code.htm 获取的验证码
    返回参数:id:用户动态id,请求需要登陆的接口时,必须携带此id
                    user_uniq_id:用户唯一id,固定不变
                    phone:用户手机号

用户登出 GET /v1/user/logout.htm
    要求参数:无
    注意:请求此接口需要登陆状态,和请求 /v1/center 路径下所有的接口一样

获取我的资料 GET /v1/center.htm
    要求参数:无
    返回参数:和登录成功后一样,且加上了该用户加入的组的相关信息,如果的加入组的话
            .....(与登录成功后返回的一样)
            group:{
                id:组的维一ID,整型
                name:组的名称
                desc:组的简介
                create_time:组的创建时间,unix时间戳 13位
            },
            user_gropu_map:{ //用户与组的关系映射表
                id:自增ID
                is_talk:是否可在这个组里发言,y为可以,n为不可以
                p_type:用户在这个组的里角色,creator(创建者),master(管理员),user(组员),visitor(访客)
                user_id:当前用户自增id,未加密
                group_id:组id
                is_report:是否接受该组产生了新信息时的通知,y为是,n为否
            }

修改我的密码 POST /v1/center/change_pwd.htm
    要求参数:pwd:string * #用户的新密码
             old_pwd:string * #用户的旧密码
             code:string * #手机验证码
    返回参数:正确或错误的通用返回

列出我加入的所有组 GET v1/center/groups.htm
    排序是按加入时间降序
    要求参数:无
    返回参数:id:自增ID
             is_talk:是否可在这个组里发言,y为可以,n为不可以
             p_type:用户在这个组的里角色,creator(创建者),master(管理员),user(组员),visitor(访客)
             user_id:当前用户自增id,未加密
             group_id:组id
             is_report:是否接受该组产生了新信息时的通知,y为是,n为否
             gropus:{
                id:组ID
                name:组名称
                desc:组简介
                create_time:组创建时间 unix时间戳 13位
             }

用户主动加入某个组 POST /v1/center/join_group.htm
    要求参数:group_id:int * #组ID
             passwd:string #如果加入组需要密码,这个也是必填项

用户主动创建一个组 POST /v1/center/create_group.htm
    注意:在提交前,请先携带组名GET一下 /v1/index/is_has_group.htm?name=组名,如果返回正确再提交,
    否则禁止提交,目提为了杜绝重复的组名,后台在创建组时,并没有处理组名重复异常,如果重复,前端会收到未知异常
    要求参数:name:string * #组名 不能超过17个汉字,超过后会自动截断
             desc:string #组的简单介绍,最多85个字
             passwd:string #加入该组时所需要的密码,如果不带或为空表示该组不需要密码
    返回参数:
             正确或错误的通用返回

用户主动离开一个组 GET /v1/center/leave_group.htm
    要求的参数:group_id:int * #组ID 需要离开的组的ID
    返回的参数:正确或错误的通用返回

更新用户最后活动痕迹 GET /v1/center/updaet_last_active.htm
    最好是当用户打开APP(小程序)时,向服务器请求一次,可抛弃返回结果
    要求参数:无
    返回参数:正确或错误的通用返回

获取用户openid GET /v1/center/ open_id_app.htm
    要求参数:无
    返回参数:
                 id:该记录 ID
                 user_id: 用户ID
                 open_id: 微信openid
                 app_id:请求时的应用ID
                 wx_app_id:openid所对应的微信生态下的应用ID
                 wx_app_name: 微信生态下的应用名称

根据微信生态下的APPID获取 openid GET /v1/center/open_id_wx_app.htm
        要求参数:app_id:微信生态下的应用id(或公众号ID)
        返回参数:同获取用户openid接口相同

保存open_id POST /v1/center/save_open_id.htm
        要求参数:app_id:微信生态下的APPID(或公众号ID)
                        app_name:微信生态下的APP名称(或公众号名)
                        open_id:用户openid
        返回参数:正确或错误的通用返回