Auth

SDK类名： /common/Auth;

短信-1.时间戳

SDK方法名：describeTimeStamp;

URL

/auth/t

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
timestamp	Number	否	, Unix 时间戳	1546847673

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String	否	@mock=
ret	Number	否	@mock=200	200
data	Object	否
t	String	否	@mock="152895584599651732", 毫妙+随机串	"152895584599651732"
code	Number	否	@mock=0	0
message	String	否	@mock=

短信-2.生成短信、邮件、图片验证码关联信息

生成短信关联信息

SDK方法名：authGenerate

URL

/auth/generate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则

Response

名称	类型	必选	简介	Mock初始值	Mock规则
data	Object	否
content	Object	否
uuid	String	否	短信唯一标识, 短信登录、获取验证码时需要一并传递	bdc7712df34ae85c30ec9ad13b1f068cf33e620a
t	String	否	msec + Math.floor(Math.random() * 99999), 时间戳毫秒+5位随机数
message	String	否	@mock=
code	Number	否	@mock=0	0
msg	String	否	@mock=
ret	Number	否	@mock=200	200

auth-获取手机、邮件、图片验证码

SDK方法名：describeVerificationCode

URL

/auth/verification_code

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
type	String	是	必传	@pick(["sms", "email", "captcha"])
uuid	String	是	必传
mobile	Number	否	短信验证 必传	18501767968
email	String		邮箱验证 必传

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
ret	Number			200
data	Object
code	Number			0
message	String
captcha	String		base64后的图片，入参type为captcha时返回	data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADgAAAAYCAMAAACY9M4aAAABhlBMVEXY39PW08rr6tHO1uLn1eLy6O7h7fTb6/vm+9bn5snwz+nWztPJ3uvf6vzU4svy+9Xo8uf4/tX23dPx3vT77+/T6Or84M3K/vXbze7gM3NtVpGpTuSUIoWOHGd7v1QCVM1POg9kY2MuYEGKUm2DBm9sUTbyC4snUxNMw0EJNcY6jNpsxm6AHhgKO/0Sxt0cKd8cmu6MAxjJ8ACJ+Hk1r9AOAnl1hkYDluDhW68opWA6VMw++kw3YyY1OJ2w7HQv/LVqZRKaCw0s/gaJMMa1Ay/Rqkf0uDM2rcYUgd2I1Y6d+0QWcI3jtS+/HARJoWpVEDgTXZJ4znQ3Vx3Bub5cW/qRv49Et1HYrI5/DCpZrsSt+GyMxw1D3vs9EplWPPqzwlKMVub6wS0LYPHPDs+vMmmrczeVWj18iI7ym2yyiDgTmQd3Bp6XRC35zLYIgU6zzIOToOaHIdjVHhustPck1sKAZu0gHKvOdeF9/w3yuuP9V4wmrTs759n3j6+HQhEiX1Y3+YmcZAnm419hAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAC4klEQVQ4jVXU2YsUMRAG8Oru6c4kk/R2d5JOtqcHDwRfxANUFA+88AJRwQvBB1G8XjzABxVF/3O/SmZXLGbD7jC//SqVztAwDN5jGYhosaC6ruo+RioKXo0h/HQdr3j56ztc3ld2pBDIB1S74AKs6R/Eh40pAZUx2ngPXlXeFwy970IYBniuCo5h/X+i4t+814/xt/c7RZFgCL6HTK1mCFMUMUZ2CAPsuo7zEt/ZQeLTfYjX0FaUYQ0F7QxJawHRK2AutFVV+Ie/scseexx6UHKpYo1WKcY3xjC0VjVKdae0xnu885KlxhZDjz22/cfBOU507liMP2K0y6y2sIM7QpQmB8kT5bAQdncBeUI/p2miRjq35tqH8wyzyQWo6VOGu4D33AXnpukzQUoLZOV6vbC2aaydGcbNCywlmgak1OouQ34Kpolzp2lpnbMo5pRcTqwq5xKUksIjbnfb6phqmtrWOQxx/ZyYz7OeZ4PEjUanvCN9VWKVkiHmctaNYw4EBFuvPdkQ5rlpAA3gJlaQDkTinCRlyDWOcOPYtt631EJaOKs58Rp61PqEzpkk+SlmeLPOkl3juFPX+gNrhrkMjuCdvpJgpOXbPZgTkee/1d4f9i0/KRhOCHzYyW02IWi32RBDJArBsO+zo/qP95e5yxZL00AZDaiBINlVFHmTN4j4OI5z5nR74jpKLY/m9dr7V3CG9/gkhIOr7flvEzlJvKS9qi/hWSa+4EWR7p0xtzgOr2q1yp8BXHZdWZIQ6Qzvj3jzDl+CJOEIsBRCh1x8qmcsWl1mKISUOAiSh7BgNOmC8XCKQuHjSuCqrxD9kBDJVyTiFLvlUsAnJyln1b+IHgxD8xVXOU9VJWgAzzE8jeHQMzBuVG5dqpNEgCilSCmhVJPgamXHEbIveS5w7n0IUnKDvN3z9EUMQ/72U1w9KkObIZVlIRJEN4isuWEhijQsLsxNfS/7XokPPV00fLPHuyb+BcmKWRXBbwXFAAAAAElFTkSuQmCC

auth-检查用户是否需要验证码

SDK方法名：checkCaptcha

URL

/auth/check_captcha

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
username	String	是	用户名	admin

Response

名称	类型	必选	简介	Mock初始值	Mock规则
data	Object
code	Number			0
message	String
need_captcha	Number			1
ret	Number			200
msg	String

auth-获取token

SDK方法名：token

'ACCESS-KEY' => 你的 access_key,

'Signature' => 你的 secret_key,

URL

/auth/token

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
pwd	String		md5, 密码，可选，用ACCESS-KEY认证时不填	Info1234
username	String		用户名，可选，用ACCESS-KEY认证时不填	admin
uuid	String		短信码 邮件码 图片验证码 唯一标识，传了uuid，会检查verification_code的值是否匹配	ff4adc96203692cc1eddfe64fa581802a5aa3a64
verification_code	Number		用户手填的验证码	1234
mobile	Number		手机号，手机登录时必选	18501767968
email	String		邮箱，邮箱登录必选	example@gmail.com
unlock	Number		解锁会话，传1	0
ldap_sw	Number		1表示使用ldap模式登录 0表示普通登录	0

Response

名称	类型	必选	简介	Mock初始值	Mock规则
data	Object	否	, api content
code	Number	否	@mock=0	0
token	String	否	@mock=@ID, token	@ID
message	String	否	, 错误提示消息
refresh_token	String	否		@guid
sso_token	String			@guid
need_captcha	Number		1, 需要展示图片验证码以及输入框，	0
ret	Number	是	@mock=200, http code	200
msg	String	是	, 提示

auth-重置密码

SDK方法名：resetPwd

URL

/auth/reset_password

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则

Response

名称	类型	必选	简介	Mock初始值	Mock规则

auth-check用户登录状态

SDK方法名：checkLoginStatus

URL

/auth/token

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
access_token	String	否	POST auth/token 返回的sso_token	a10b45cd8b94ad53UEsc8H-gxjMU-jX76eFd2z4eoDh0vlVkPPDWaJyBWssjwWdYAtk4SdFaL8dQH48QQv29c3TRNX3FQo4Ub_V1qwehbRQ28KBEtYqTG6wy8sbAEWPVcBoE2uWXnmP_J5R9hXl8yHbeyaMwMjLpWe0onA

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Array	否
message	String	否
code	Number	否		0
username	String	否		admin

auth-注册账号(不开放)

SDK方法名：regAccount

URL

/auth/register

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否	@mock=200	200
msg	String	否
data	Array	否
message	String	否	@mock=success update to latest version	success update to latest version
code	Number	否	@mock=0	0

auth-是否超时或账号失效

SDK方法名：heartbeat;

URL

/auth/heartbeat

Method

PUT

Request

名称	类型	必选	简介	Mock初始值	Mock规则
refresh_token	String			null

Response

名称	类型	必选	简介	Mock初始值	Mock规则
data	Object
code	Number			0
message	String
msg	String
ret	Number			200

auth-公钥处理

URL

/auth/encry_key

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuid	String
type	String			@pick(["sm4", "email", "captcha"])
encry_key	String

Response

名称	类型	必选	简介	Mock初始值	Mock规则
msg	String
ret	Number			200
data	Object
code	Number			0
message	String