果果云 / 后台接口 / 获取接口的请求参数与返回参数

获取接口的请求参数与返回参数

接口描述: 获取某个参数的请求参数和返回参数

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

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
api_name字符串必须-接口名称

参数名字

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.codebool获取状态
data.msg字符串获取的信息
data.requestParams字符串接口请求参数,包括(name名字 require是否必须 desc描述)
data.responseParams字符串接口返回参数,包括(type类型 name名字 desc描述)
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
api_name 必须

客户端请求示例

{
    "ret": 200,
    "data": {
        "code": true,
        "msg": "获取成功",
        "requestParams": {
            "appKey": {
                "name": "app_key",
                "required": "必须",
                "desc": "app_key,用于区分客户端应用"
            },
            "appSecret": {
                "name": "app_secret",
                "required": "必须",
                "desc": "应用密钥"
            },
            "accessToken": {
                "name": "access_token",
                "required": "可选",
                "desc": ""
            },
            "uid": {
                "name": "uid",
                "required": "可选",
                "desc": "授权的用户id,如果用户已登录可加传此参数,以便后续服务端判断用户是否已登录"
            }
        },
        "responseParams": {
            "access_token": {
                "name": "access_token",
                "type": "string",
                "desc": "新的访问令牌,申请失败时返回空字符串"
            },
            "expire_at": {
                "name": "expire_at",
                "type": "int",
                "desc": "过期时间戳"
            }
        }
    },
    "msg": ""
}

错误列表

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

本文档生成时间:2020-07-10 02:31:25