全局要求
除明确指出外，以下说明适用于于所有接口。
通信协议：
基于TCP/HTTP(S)协议，HTTPS必须使用TLS1.2版本及以上。
请求头部：
请求和响应均为JSON格式。因此需要为所有接口指定Accept和Content-Type报头，即：
Accept: application/json
Content-Type: application/json
请求谓词：
| 谓词 | 适用场景 |
|---|---|
| GET | 对某一资源进行“查询、搜索、获取”操作 |
| POST | “创建、新增、插入”某一资源 |
| PUT | “更新、更改/变更”某一资源下的相关信息 |
| DELETE | “删除”某一资源 |
响应状态码：
| 代码 | 说明 |
|---|---|
| 20* | 请求已接收，接口已响应 |
| 30* | 服务端地址发生变更，需要重定向或更换接口地址 |
| 400 | 参数无效、缺失或格式错误 |
| 401 | 未提供必要的身份验证或身份验证无效 |
| 402 | 请求失败（参数验证通过，但是请求无法成功） |
| 403 | 权限禁止的请求 |
| 404 | 请求的资源不存在 |
| 429 | 请求频率超过限定 |
| 50* | 服务器异常或内部错误 |
响应正文格式：
除明确指出外，后续所有接口响应参数均在此格式下。
| 名称 | 类型 | 必须 | 说明 |
|---|---|---|---|
| status | 数值 | 必须 | 当前请求的响应状态码，与http状态码同步 |
| message | 文本 | 必须 | 当前请求的响应状态码的描述或说明 |
| data | *参阅对应接口 | *参阅对应接口 | 为当前请求接口的具体响应，参阅对应接口中的“响应正文” |
| timestamp | 数值 | 必须 | 为当前请求接口的响应时间戳（毫秒） |
200状态码示例：
30*状态码示例：
400状态码示例：
401状态码示例：
500状态码示例：
未列举的状态码格式同上，参阅实际响应。
变更记录
[2024-09-01]初始发布。
使用声明
仅限银珏平台的SaaS租户使用。
请勿将您的身份凭证（如密钥等）发送或存储到第三方。
禁止以存在侵入的方式使用接口（如：超过限制频率、功能用途、法规限定等）。
请及时关注该文档，接口更新恕不另行通知。