OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
username | String | Required | MIN: 1 | 需要找回密码的应用会员账号 | |
email_field | String | Optaion | yesapi_email | 会员扩展信息中邮箱的字段名称,且会员的邮箱不能为空 | |
expire_time | Int | Optaion | 3600 | MIN: 60;MAX: 3600 | 单位:秒,表示邮件动态验证码多少时间内有效,最短1分钟,最长1小时。 |
code_len | Int | Optaion | 6 | MIN: 4;MAX: 8 | 动态验证码的长度,由大小写和数字组成。 |
code_type | Int | Optaion | 动态验证码的类型:默认-数字+大小写字母;1-纯数字;2-纯小写字母;3-纯大写字母;4-大小写字母 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
username | *Required | |
email_field | Option | |
expire_time | Option | |
code_len | Option | |
code_type | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 操作状态码,0成功,1会员不存在,2员邮箱为空或邮箱地址非法,3邮件动态验证码已发送 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
HTTP Response Code
HTTP Status Code | Description |
---|---|
Http Status = 200 | Success |
Http Status = 400 | Illegal-Params |
Http Status = 401 | Illegal-Token |
Http Status = 402 | IP-Banned |
Http Status = 404 | API-NOT-Exsits |
Http Status = 406 | Illegal-APPKEY |
Http Status = 407 | APPKEY-Expired-Out |
Http Status = 408 | APPKEY-Busy |
Http Status = 409 | Illegal-Sign |
Http Status = 413 | API-Traffic-NOT-Enough |
Http Status = 415 | API-LOCKED |
Http Status = 500 | Internal-Server-Error |