5. API 与系统集成

a month ago

87da6cb

API 参考

dwz-server 对外提供 RESTful API，基础路径为：

http://{host}/api/v1

所有请求与响应使用 application/json；短链接跳转 GET /{code} 为 HTTP 302。

{
  "code": 0,
  "message": "success",
  "data": { ... }
}

code = 0 表示成功
非零业务码示例：40001（参数错误）、40101（未认证）、40301（权限不足）、40401（资源不存在）、50001（服务器内部错误）

HTTP 状态码与 code 配合：200 = 业务成功，4xx / 5xx 对应错误分类。

除少数公开接口外，所有接口都需要认证。认证方式详见下一章节。