HTTP/HTTPS
请求协议
EagletAPI / OpenAPI /
接口地址：http://api.kittyhawks.cn/api/app.php?s=App.Auth.ApplyToken
接口描述： 通过应用校验进行授权，根据客户端应用的app_key和app_secret创建新的访问令牌
接口参数
| 参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
|---|---|---|---|---|---|
| app_key | 字符串 | 必须 | - | app_key，用于区分客户端应用 | |
| app_secret | 字符串 | 必须 | - | 应用密钥 | |
| uid | 整型 | 可选 | 授权的用户id，如果用户已登录可加传此参数，以便后续服务端判断用户是否已登录 |
返回字段
| 返回结果 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务器错误 |
| data | 对象或混合类型 | 业务数据，由各自接口指定，通常为对象 |
| data.access_token | 字符串 | 新的访问令牌，申请失败时返回空字符串 |
| data.expire_at | 整型 | 过期时间戳 |
| msg | 字符串 | 提示信息，失败时的错误提示 |
在线测试
| 参数 | 是否必须 | 值 |
|---|---|---|
| service | 必须 | |
| app_key | 必须 | |
| app_secret | 必须 | |
| uid | 可选 |
客户端请求示例
{
"ret": 200,
"data": {
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJwaGFsYXBpX3BybyIsImF1ZCI6InBoYWxhcGlfcHJvIiwic3ViIjoidGVzdCIsInVpZCI6IiIsImlhdCI6MTU3Njc0MDUyMywiZXhwIjoxNTc2ODI2OTIzfQ.oHIFIfGE9C3e2BFJrCWH8jVEtVPoo7V3_5QmtHwezLM",
"expire_at": 1580442248
},
"msg": ""
}
错误列表
| 错误状态码 | 错误描述信息 |
|---|---|
| 400 | ret=400，客户端参数错误或非法请求 |
| 404 | 表示接口服务不存在 |
| 406 | ret=406，access_token令牌校验不通过 |
| 407 | ret=407，app_key权限不足，或未知应用 |
| 408 | ret=408，当前用户禁止使用，或用户未登录 |
| 500 | 表示服务端内部错误 |
本文档生成时间：2024-11-21 20:02:21