用户登录

接口说明

​ 该接口用于用户正常在客户端上通过 账号密码/手机号验证码 的方式操作登录时调用

基本信息

请求方式： POST

请求地址：https://sso-center.myyscm.com/v2/user/login

请求参数

参数名 参数位置 参数类型 是否必填 默认值 描述
loginType Body String 是 登录类型，目前支持两种：
MOBILE_AND_SMS（手机验证码登录）、
ACCOUNT_AND_PWD（账号/手机号+密码登录）
appid Body String 是 应用 AppID（星图应用的 AppKey）
countryCode Body Number 否 86 手机号所属区号，默认中国大陆 86
mobile Body Number 是 手机号，MOBILE_AND_SMS 登录模式下需要提供
smsCode Body Number 是 短信验证码，MOBILE_AND_SMS 登录模式下需要用到
account Body String 是 账号/手机号，ACCOUNT_AND_PWD 登录模式下需要用到
password Body String 是 登录密码，ACCOUNT_AND_PWD 登录模式下需要用到
tenantCode Body String 否 租户号，不提供时登录认证通过只能拿到一个临时凭证 Ticket，需要进一步调用 Ticket 登录接口获取授权令牌数据。方便接入方自由定制自己的客户端交互流程
deviceId Query String 否 设备号

请求示例

POST
https://sso-center.myyscm.com/v2/user/login?deviceId=DEVICE_ID

# 短信验证码登录时
{
  "loginType": "MOBILE_AND_SMS",
  "appid": "TjqhxiyUEkYt5beLfek1bxBMvF8zMtrZ",
  "countryCode": 86,
  "mobile": 18577889900,
  "smsCode": 1234,
  "tenantCode": "cjap"
}

# 密码登录时
{
  "loginType": "ACCOUNT_AND_PWD",
  "appid": "TjqhxiyUEkYt5beLfek1bxBMvF8zMtrZ",
  "account": "yourAccount",
  "password": "yourLoginPassword",
  "tenantCode": "cjap"
}

成功返回示例

# 提供了租户号时，接口调用成功的数据返回
{
  "errcode": 0,
  "message": "Success",
  "data": {
    "accessToken": "iyJ9P2Tcl5OK5Aom74do28xuBFHky74h",
    "refreshToken": "5dQlGaYsGcCcdrYLWCzobxjcCqWBXqit",
    "expireTime": 7200,
    "refreshTime": 2592000
  }
}

# 没有提供租户号时，接口调用成功的数据返回
{
  "errcode": 0,
  "message": "Success",
  "data": {
    "ticket": "VLmNUv3J4AfWx6Dv"
  }
}

成功返回参数说明

参数名 参数类型 描述
data.accessToken String 访问令牌
data.refreshToken String 刷新令牌
data.expireTime Number 访问令牌剩余的有效时间，默认 2 小时（单位：秒）
data.refreshTime Number 刷新令牌剩余的有效时间，默认 30 天（单位：秒）
data.ticket String 登录临时凭证，可利用该参数通过 Ticket 登录接口换取授权令牌数据

失败返回示例

{
  "errcode": 10001,
  "message": "Failure message."
}

失败返回参数说明

参数名 参数类型 描述
errcode Number 业务错误码，0 正常，非 0 均为发生业务错误
message String 接口响应数据业务说明，调用失败时为相应的错误说明

results matching ""

    No results matching ""