EagletAPI / OpenAPI /

接口描述: 通过应用校验进行授权,根据客户端应用的app_key和app_secret创建新的访问令牌

HTTP/HTTPS
请求协议
GET/POST
请求方式
UTF-8
编码格式
JSON
返回格式

接口参数

参数名字类型是否必须默认值其他说明
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": ""
}

错误列表

错误状态码错误描述信息
400ret=400,客户端参数错误或非法请求
404表示接口服务不存在
406ret=406,access_token令牌校验不通过
407ret=407,app_key权限不足,或未知应用
408ret=408,当前用户禁止使用,或用户未登录
500表示服务端内部错误

本文档生成时间:2024-11-01 08:58:54