OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
code | String | Required | 微信小程序 登录凭证 code | ||
iv | String | Optaion | 加密算法的初始向量 | ||
encryptedData | String | Optaion | 包括敏感数据在内的完整用户信息的加密数据 | ||
appname | String | Optaion | 小白开放平台配置的应用名称,如果是默认配置,此字段则可不传 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
code | *Required | |
iv | Option | |
encryptedData | Option | |
appname | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
openid | String | 用户唯一标识 |
unionid | String | 用户在开放平台的唯一标识符。本字段在满足一定条件的情况下才返回,小程序只有绑定了服务号才有此字段返回。 |
nickname | String | 用户昵称 只有传了iv和encryptedData才会返回,小程序只有绑定了服务号才有此字段返回。 |
avatarUrl | String | 用户头像,最后一个数值代表正方形头像大小(有0、46、64、96、132数值可选,0代表640*640正方形头像),用户没有头像时该项为空。若用户更换头像,原有头像URL将失效。 只有传了iv和encryptedData才会返回,小程序只有绑定了服务号才有此字段返回。 |
gender | String | 用户的性别,值为1时是男性,值为2时是女性,值为0时是未知 只有传了iv和encryptedData才会返回,小程序只有绑定了服务号才有此字段返回。 |
city | String | 用户所在城市 只有传了iv和encryptedData才会返回,小程序只有绑定了服务号才有此字段返回。 |
province | String | 用户所在省份 只有传了iv和encryptedData才会返回,小程序只有绑定了服务号才有此字段返回。 |
country | String | 用户所在国家 只有传了iv和encryptedData才会返回,小程序只有绑定了服务号才有此字段返回。 |
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 |