API 请求说明

1/ 返回数据结构

请求成功示例：

json

{
    "code": 200,
    "msg": "请求成功",
    "data": {
        "text": "返回数据",
        "array": ["数","据","内","容"]
    }
}

{
    "code": 200,
    "msg": "请求成功",
    "data": {
        "text": "返回数据",
        "array": ["数","据","内","容"]
    }
}

请求失败示例：

json

{
    "code": 401,
    "msg": "请传入正确的 API Key",
    "data": null
}

{
    "code": 401,
    "msg": "请传入正确的 API Key",
    "data": null
}

json

{
    "code": 403,
    "msg": "暂无权限访问",
    "data": null
}

{
    "code": 403,
    "msg": "暂无权限访问",
    "data": null
}

json

{
    "code": 404,
    "msg": "没有找到",
    "data": null
}

{
    "code": 404,
    "msg": "没有找到",
    "data": null
}

json

{
    "code": 500,
    "msg": "内部错误",
    "data": null
}

{
    "code": 500,
    "msg": "内部错误",
    "data": null
}

不同请求返回的msg字段各不相同，请通过code字段判断请求的结果。

旧版 API、测试阶段 API 可以直接调用，无需传入 API 应用信息：

html

# 旧版（V1）API
https://api.tsinbei.com/v1/foo/?key=value

# 测试阶段 API
https://api.tsinbei.com/demo/testFoo/?key=value

# 旧版（V1）API
https://api.tsinbei.com/v1/foo/?key=value

# 测试阶段 API
https://api.tsinbei.com/demo/testFoo/?key=value

WARNING

这些接口随时可能会被更改以符合新版 API 规范并且要求鉴权，如果在生产环境中使用请特别注意。

新版接口需要在应用中心申请 API 应用，申请成功后获得app_id和api_key，使用方法参考下文。

每个应用都有一个特有的 App ID，是应用的标识码。一个应用中，可以创建多个密钥对，分配不同权限，但是允许通过此应用的密钥对访问的权限由这个应用所允许访问的权限决定。

请求示例：

html

https://api.tsinbei.com/v2/foo/?appId=10000&key=value

https://api.tsinbei.com/v2/foo/?appId=10000&key=value

我们使用 API Key 作为访问时需要的身份校验手段。部分 API Key 可以暴露给用户，属于 Read-only API Key。

请求示例：

html

https://api.tsinbei.com/v2/foo/?api_key=AAAA8888&key=value

https://api.tsinbei.com/v2/foo/?api_key=AAAA8888&key=value

我们使用 Secret Key 作为和服务器通信时需要的身份校验手段，一般用于添加、修改、删除信息等敏感操作，属于 Admin API Key。

html

https://api.tsinbei.com/v2/foo/?api_key=ZZZZ6666&key=value

https://api.tsinbei.com/v2/foo/?api_key=ZZZZ6666&key=value