接入指南

云网移动应用是指航天云网所开发App。开发者可以通过调用该类接口,来实现App下用户注册、用户登录、用户及企业信息管理等功能。

详细接口可参考App服务接口,具体使用示例如下:

用户注册

使用用户手机号进行注册,注册时需要填写相关信息包括:手机号、手机验证码、密码,其中手机号要校验唯一性。

注册用户可分为三步:

  • 第一步:验证手机号是否存在
  • 请求示例:https://auth.ms.casicloud.com/1/user/exist?client_id=&ts=&sign=&mobile=
  • 第二步:发送手机验证码
  • 请求示例:https://auth.ms.casicloud.com/1/user/check_verifycode?client_id=&ts=&sign=
    注:同一手机号,验证码发送次数:1分钟内不超过1次,24小时内不超过5次。验证码5分钟内有效。
  • 第三步:注册用户
  • 请求示例:https://auth.ms.casicloud.com/1/user/add?client_id=&ts=&sign=

请求参数说明

参数名 是否必须 类型 参数描述
mobile string 手机号,校验唯一性
password string 密码
verifycode string 手机验证码
system_id long 子系统ID
注: 密码长度6-19,且至少含数字、小写字母、大写字母、特殊字符(!@#$&_.)中的两种。

Post请求示例:

{
"mobile": "18800010001",
  "password": "abc123",
  "system_id": 100,
  "verifycode": "1234"
}

                                

返回成功示例:

{
  "code": 200,
  "data": {
    "account": "zhangsan",
    "create_time": "2010-01-01 00:00:00",
    "email": "test@163.com",
    "fullname": "管理员",
    "is_admin": true,
    "is_email_true": "1",
    "is_mobile_true": "1",
    "mark": 5,
    "mobile": "18800010001",
    "open_id": "fc8568a6f1cf4b5297ad64d0bef81a6c",
    "org_id": 5100941,
    "phone": "010-12345678",
    "picture": "http://img.casicloud.com/1.jpg",
    "sex": "1",
    "short_account": "zhangsan",
    "status": "1",
    "system_id": 100,
    "update_time": "2010-01-01 00:00:00",
    "update_times": 1,
    "user_id": 1393817040
  },
  "msg": ""
}

                                    

返回失败示例:

{
"code": 1002,
"data": null,
"msg": "用户手机号已存在"
}
用户登录

开发者可以调用登录认证接口,通过用户名密码认证方式进行登录,其中用户名可以是手机号、邮箱、账号三者之一,认证成功后接口将返回认证信息。

具体请求如下:

接口名称:用户登录认证

请求示例: https://auth.ms.casicloud.com/1/user/auth?client_id=&ts=&sign=

请求参数说明:

参数名 是否必须 类型 参数描述
user_name string 可以是mobile, account, email三者之一
password string 密码

Post请求示例:

{
 "password": "abc123",
 "user_name": "18800010001"
}

返回成功示例:

{
  "code": 200,
  "data": {
    "access_token": "AccessToken",
    "client_id": "ClientId",
    "expires_in": 28800,
    "refresh_token": "RefreshToken",
    "scope": "app_scope",
    "user_id": 1393817040
  },
  "msg": ""
}

返回失败示例:

{
"code": 2106,
"data": null,
"msg": "用户名或密码错误"
}
用户及企业信息管理

用户认证成功后,得到认证票据access_token,在调用用户信息和企业信息相关接口时,需要在请求头Header中加入Authorization参数,其值为Token[空格][access_token]。

接口名称:更新用户密码

使用场景:当登录的用户需要变更密码时,可以调用该接口。

请求示例: https://auth.ms.casicloud.com/1/user/update_password?client_id=&ts=&sign=

Header参数

参数名 是否必须 类型 参数描述
Authorization string 该参数的值为:Token [空格][AccessToken]

请求参数说明

参数名 是否必须 类型 参数描述
old_password string 旧密码
new_password string 新密码

Post请求示例:

{
  "new_password": "abc1234",
  "old_password": "abc123"
}

返回成功示例:

{
  "code": 200,
  "data": true,
  "msg": ""
}

返回失败示例:

{
"code": 1012,
"data": null,
"msg": "用户密码格式不正确"
}