准备开发

如何调用 API

开发前须知

1. 在调用 API 前，需要先联系平台创建应用，获取权限和凭证。

2. 所有接口限制每个应用最高频率 50 次/秒。

API 文档约定格式

开放平台 API 文档格式主要如下：

请求：
    基本信息
    请求头
    路径参数
    查询参数
    请求体
    请求体示例
响应：
    响应体
    响应体示例
    错误码

API 调用流程

1. 获取 API 调用所需要的凭证

2. API 调用时需要将凭证放入 Header 中，使用语法 Authorization: Bearer <credentials> 进行调用。

API 调用方式

调用接口时，需要使用 HTTPS 协议、JSON 数据格式、UTF8 编码。请求需要把访问凭证 access token 放到 Header 的 Authorization 中。

示例 ：

curl -X POST 'https://api.hwgwb.com/v1/file/upload'
-H 'Authorization:Bearer <这里替换为对应的access token>'
-H 'content-type:application/json; charset=utf-8'
-F 'file=@"/path/to/file"'

API 响应结果说明

API 的响应体结构包括 code、msg、data 三个部分。

code 为错误码，msg 为错误信息，data 为 API 的调用结果。默认请求成功时，code 为 0，msg 为 success。data 在一些操作类 API 的返回中可能不存在。

例如：

{
  "code": 0,
  "msg": "success"
}

{
  "code": 0,
  "msg": "success",
  "data": {
    // 响应的具体数据内容
  }
}

{
  "code": 40004,
  "msg": "no authority"
}