# 服务地址

SaaS平台请求地址:https://url
其他私有化部署的场景,请将URL替换为相应的标注平台服务地址。

# 通信协议

SaaS平台 API 的所有接口均通过 HTTPS 进行通信,提供高安全性的通信通道。
私有化部署的场景,视实际部署情况。可能是 HTTP 或 HTTPS 其中的一种。

# 请求方法

目前支持的 HTTP 请求方法:
●  POST
●  GET
●  DELETE
●  PATCH

后面随着新接口的增加,会支持更多的请求方法。
POST请求单次文件大小不能超过1000M。

# 字符编码

均使用 UTF-8 编码。

# 返回格式

所有接口返回的格式一样,均为json,如下:

{
    "code":0,
    "message":"错误提示信息",
    "***":"***"
}

# 返回结果说明

序号 名称 说明
1 code 返回状态码,整数。正确时为0。公共错误码为负整数,接口业务错误码为正整数。
2 message 错误提示信息,当code为非0时,该消息有值,否则为”调用成功“。
3 *** 正确返回时的业务返回数据。

# 公共错误码

序号 错误码 错误提示信息
1 -1 内部错误
2 -2 secretid错误
3 -2 secretid不能为空
4 -3 签名错误
5 -3 签名重复使用
6 -3 签名不能为空
7 -3 签名过期
8 -4 时间戳格式错误
9 -4 签名时间戳大于当前服务器时间戳
10 -4 时间戳不能为空