跳转至

API 基础

OpenASA 运行时 API 的通用规则汇总如下。

基础地址

  • 生产接入基地址:https://api.openasa.com/

本文档中的所有路径都相对于该基地址。

鉴权规则

  • 浏览器场景使用 Session Cookie 鉴权。
  • 必须登录的接口组包括:
  • /me/*
  • 评论写入接口(POST .../comments
  • /auth/* 下受保护端点
  • /cli/device/approve

常见状态码

  • 200:成功
  • 400:请求参数或请求体不合法
  • 401:会话缺失或过期
  • 404:资源不存在
  • 500:服务内部错误
  • 502:地理定位上游失败(/geo/ip-locate

错误结构

错误响应通常包含:

  • error:机器可处理的错误标识
  • message:面向用户的错误说明

具体字段以端点 OpenAPI 合同为准。

限流点

限流主要作用于:

  • 邮箱登录申请/验证接口
  • CLI challenge/device 接口
  • 评论写入接口

调用方建议使用指数退避重试。