Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

对外 API 文档

本文档面向第三方调用方,覆盖以下内容:

  • 公共参数约定
  • API Key 获取方式
  • 公共错误码
  • 能量下单接口
  • 激活接口

基础信息

  • OpenAPI 前缀:/api/v1/openapi
  • 数据格式:application/json
  • 鉴权方式:
    • 获取 API Key 使用 JWT(Authorization: Bearer <token>
    • OpenAPI 业务接口使用查询参数 apikey

统一响应结构

{
  "code": 200,
  "message": "SUCCESS",
  "data": {}
}

说明:

  • code: 业务码(非 HTTP 状态码)
  • message: 业务提示信息
  • data: 业务数据(不同接口结构不同)