API概览

为方便二次开发，我们提供了丰富的OpenAPI接口，支持 个人访问令牌 和 应用访问令牌 认证方式。OpenAPI文档可通过API Swagger文档或本目录下集成的子文档查询。

OpenAPI令牌获取

获取令牌

OpenAPI访问示例

• 入口地址：<主域名>/oapi/v1
• 请求示例

  curl -X 'GET' \
  'https://<your-host>/oapi/v1/platform/users?status=enabled' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'x-yunxiao-token: <your-token>'
  

• 返回结构

  [
  {
    "email": "string",
    "id": "string",
    "joinDate": "string",
    "name": "string",
    "nickName": "string",
    "staffId": "string",
    "sysDeptIds": [
      "string"
    ],
    "username": "string"
  }
  ]