EN

API 文档

认证与 API Key

了解哪些接口是公开的、哪些接口需要 API key,以及如何在站点里完成凭证管理。

打开 llm.txt

Axiora 的站点登录态用于账户管理,真正请求受保护数据接口时使用 API key。也就是说,浏览器里的登录会话和程序里的数据请求凭证是两件不同的事。

认证模型

  • public 接口可以直接调用,适合健康检查、基础市场枚举和初次连通性验证
  • apiKey 接口必须携带 X-API-Key
  • API key 在用户中心创建、复制和吊销;明文只展示一次

什么时候必须先登录站点

当你需要创建、吊销或查看 API key 时,需要先登录 Axiora 站点。登录站点本身不会替程序自动附带 key;程序侧仍然需要显式传递 X-API-Key

如何传递 API Key

GET/api/v1/markets/{market}

Get one market

getMarket

需要 API Key

Reference 会告诉你某个接口是否需要 key;这里的重点是调用方式本身。对需要鉴权的接口,统一通过 X-API-Key 请求头传递凭证。

curlbash
curl "https://heliumlabz.com/api/v1/markets/CN" \
-H "X-API-Key: $ASHARE_API_KEY"
JavaScript fetchts
const response = await fetch("https://heliumlabz.com/api/v1/markets/CN", {
headers: {
  "X-API-Key": process.env.ASHARE_API_KEY ?? "",
},
});

账户与密钥管理

  1. 在站点右上角登录或注册
  2. 进入 Profile
  3. API Keys 标签页创建新 key
  4. 立即复制明文 key 并保存到密码管理器或环境变量
  5. 程序调用时统一从环境变量读取

不要把 API Key 写死到前端

API key 适合服务端、脚本、CLI 或受控环境。不要把密钥直接暴露在浏览器端代码或公开仓库里。