本文为您介绍了 OpenAPI 调用的整体流程、接口调用限制以及公共错误码，重点介绍了 OpenAPI 调用时必备的 Token 申请和使用方法。

1. 为每一个 openapi 调用方生成一个 client id 和 client secret，这是调用接口的凭证。
2. 用户使用 client id / client secret 调用接口交换包含用户身份信息的 jwt token。
3. 用户在调用业务接口时在请求头部带上 jwt token，例如：Authorization: Bearer jwt_token 。
4. DataWind 在接口被调用时，使用公钥校验 jwt token，完成限流检查、审计。
5. 在调用任意一个 DataWind 接口时，为了便于后续问题的排查，建议在请求的 headers 中添加 x-request-id 和 request-id(保证唯一字符串即可)， 需要两个 header 是因为 DataWind 整体组件比较多，各个组件之间使用的标记可能不同。这两个参数会被输入到 DataWind 的后端日志中，为您在遇到问题时进行分析和定位提供有力的支持，从而更高效地解决可能出现的故障。
6. 返回业务结果。

整体流程如下：

获取clientId与clientSecret #

进入「开放平台」-> 「开发者后台」，点击「创建凭证」申请clientId、clientsecret ，申请的凭证类型分为两种类型：用户、系统(仅支持系统管理员) 。如下图：

获取jwtToken #

请求说明 #

请求地址：不同环境调用接口使用的接口地址不同。

• 如果是私有化部署环境，调用接口的使用的地址前缀与私有化环境访问地址一致。
• 如果是火山引擎 SaaS 环境，访问地址为https://console.volcengine.com/bi/datawind，则接口地址前缀为https://console.volcengine.com/bi/datawind/aeolus。

请求示例 #

curl --location --request POST 'https://console.volcengine.com/bi/datawind/aeolus/api/v3/openapi/jwtToken' \
--header 'Content-Type: application/json' \
--data-raw '{
  "metadata": {
    "clientId": "{clientId}",
    "clientSecret": "{clientSecret}",
    "proxyUser": "abc****@21**********",
    "expire": 3600
  }
}'

请求参数 #

返回参数 #

返回示例 #

{
    "code": "aeolus/ok",
    "data": {
        "jwtToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.ey*****************************************************************************************************************************************************************************.********************-*************************************************************************************-****************************************************************************************************************************-***-********************************************-******************************************************-*************************-****************************************************************************-************-*************************************-*********************************************************************************************************************************************************-****************-******************5sus",
        "proxyUser": "user_1"
    },
    "msg": "成功"
}

用户在调用接口时需要在请求头部带上 jwtToken 的内容，例如：Authorization: Bearer jwt_token
使用 curl 的调用 current user 接口示例如下：

curl -X GET 'https://{domain}/aeolus/api/v3/open/misc/current_user' \
-H 'Authorization: Bearer jwt_token'

为了保障服务稳定性与阻挡恶意攻击，DataWind 后端采用以下方法限制请求：
（1）限流（目前接口对外服务承载能力已达到较高水平，如仍不满足需求，可联系火山引擎技术支持团队申请修改）；
（2）封禁，用于保留一些不开放的 api 或者临时封禁用户的异常请求；
（3）审计，每一次 openapi 调用均会被记录，包括调用方、接口、参数、调用时间。

详情可查看公共错误码。