Skip to main content

API 概览

Vocnet 对外提供 HTTP/JSON API（/api/v1/...）。第三方应用通过 OAuth2 获取 access token 后，以 Bearer Token 调用接口。

基本约定​

  • Base URL：{BASE_URL}（由你的实例决定）
  • API 前缀：{BASE_URL}/api/v1
  • Content-Type：application/json
  • 认证：Authorization: Bearer <access_token>

错误处理（建议）​

当请求失败时，集成方至少应记录：

  • HTTP status code
  • 响应体中的错误信息（如存在）
  • requestId（如响应头提供）

分页与过滤​

列表接口通常支持：

  • page_size
  • page_token
  • filter

过滤能力与设计说明见：