Skip to content
On this page

Overview - 概要

HamsterBase 所有的 API 都以 /public/api/v1 开头

授权

  1. 访问 /settings/api 创建新的 API token. 格式类似于 ZT478FS-XCB4CD1-N3XMPJC-ZT2FVNX

  2. 调用 API 时,假设 Token 为 ZT478FS-XCB4CD1-N3XMPJC-ZT2FVNX, 需要在请求头中附加如下信息:

    Authorization: Bearer ZT478FS-XCB4CD1-N3XMPJC-ZT2FVNX
    

格式概述

API 响应格式为 JSON。每个成功的 API 请求都会返回 200 状态码。

JSON 响应格式如下:

ts
interface HamsterBaseResponse<T> {
  success: boolean;
  /**
   * 返回结果
   */
  data: T;
  /**
   * 错误信息
   */
  errorCode?: string;
  errorMessage?: string;
}