Overview

基本路径

所有 API 的路径都以 https://alynx.alifanyi.com/api/ 开头。

HTTP 请求说明

POST、PUT 请求的时候,请确保Request Content-Typeapplication/json类型。

req.Headers.Add("Content-Type", "application/json")

用户认证

ALYNX API目前使用Token机制来实现用户认证, 所有请求必须通过Token验证后方可执行。请联系管理员提供Token

返回格式

{
    "data": {
    },
    "success": true,
    "bizErrorCode":1000,
    "errorMessage": "错误消息"
}
//其中当success为true时,bizErrorCode为1000,data是返回具体内容。
//当success为false时,通过bizErrorCode会显示错误码,请根据错误码表格判断具体错误信息。

错误码

即返回数据中bizErrorCode的数值,默认是int形式。

错误码

描述

1000

操作成功

1001

未知异常, 请重试

1002

账户错误

1003

Token 已过期,请重新申请

1004

预设的配置不存在

1006

无权限

1007

参数缺失,请查看API 的接口的要求

1009

项目已存在

1010

文件无法下载

访问频率限制

每个用户(基于Token关联到的账户),100 次/小时。