获取接口调用 token

POST /miniapp/v1/apps/{app_id}/access-token

应用后端用当前 AppSecret 获取 2 小时接口 token；默认在同一密钥代次内返回仍有效的稳定 token，force_refresh=true 会立即吊销旧 token 并签发新 token。应用停用、密钥冻结或密钥重置后不能签发；重置或冻结会在同一事务中吊销旧 token，解冻不会恢复旧 token。AppSecret 只出现在 HTTPS JSON 请求体且不得记录。

鉴权与参数

AppSecret 放在 HTTPS JSON 请求体的 app_secret 字段中，只保存在应用后端；不要使用 Authorization Header 传 AppSecret。

参数	位置	必填	说明
`app_id`	path	是	{"type":"string","pattern":"^[a-z][a-z0-9_-]{2,63}$"}

请求体

Content-Type：application/json。

字段	类型	在所属对象中必填	说明与约束
`app_secret`	string	是	description: 当前 AppSecret，仅由应用后端通过 HTTPS 提交且不得记录。；pattern: ^msec_[0-9a-f]{64}$
`force_refresh`	boolean	否	description: true 时吊销同一密钥代次内仍有效的接口 token 并签发新 token。

响应

HTTP 200

当前密钥代次内的接口 token；响应禁止缓存。

字段	类型	在所属对象中必填	说明与约束
`code`	string	是	description: 请求成功时返回的稳定业务码。；const: miniapp_success
`data`	object	是	additionalProperties: false
`data.access_token`	string	是	description: 仅由应用后端保存的接口 token。；pattern: ^mat_[0-9a-f]{64}$
`data.expires_in`	integer	是	format: int64；minimum: 0；maximum: 7200
`data.expires_at`	string	是	format: date-time

HTTP 400

请求参数无效。

字段	类型	在所属对象中必填	说明与约束
`error`	object	是
`error.code`	string	是
`error.message`	string	是
`error.request_id`	string	否	description: 与响应头 X-Request-ID 相同，用于查询服务端失败诊断。；maxLength: 128
`error.details`	object	否	additionalProperties: false
`error.details.reason`	string	否

HTTP 401

宿主身份、AppSecret、接口 token 或运行时会话无效。

字段	类型	在所属对象中必填	说明与约束
`error`	object	是
`error.code`	string	是
`error.message`	string	是
`error.request_id`	string	否	description: 与响应头 X-Request-ID 相同，用于查询服务端失败诊断。；maxLength: 128
`error.details`	object	否	additionalProperties: false
`error.details.reason`	string	否

HTTP 409

状态冲突或幂等键冲突。

字段	类型	在所属对象中必填	说明与约束
`error`	object	是
`error.code`	string	是
`error.message`	string	是
`error.request_id`	string	否	description: 与响应头 X-Request-ID 相同，用于查询服务端失败诊断。；maxLength: 128
`error.details`	object	否	additionalProperties: false
`error.details.reason`	string	否

HTTP 503

依赖的适配器或存储不可用。

字段	类型	在所属对象中必填	说明与约束
`error`	object	是
`error.code`	string	是
`error.message`	string	是
`error.request_id`	string	否	description: 与响应头 X-Request-ID 相同，用于查询服务端失败诊断。；maxLength: 128
`error.details`	object	否	additionalProperties: false
`error.details.reason`	string	否

完整定义

下列定义包含引用、Header 和字段约束，来自同一契约的本接口投影。

查看 JSON Schema 与响应定义

json

{
  "openapi": "3.1.0",
  "info": {
    "title": "MetaEco 应用服务端 API",
    "version": "40.68.0"
  },
  "servers": [
    {
      "url": "{platformOrigin}",
      "description": "导入后填写实际 API 入口；文档域名不承载 API",
      "variables": {
        "platformOrigin": {
          "default": "https://api.example.invalid",
          "description": "替换为当前应用分配的 API 网关，示例域名不可访问"
        }
      }
    }
  ],
  "paths": {
    "/miniapp/v1/apps/{app_id}/access-token": {
      "post": {
        "summary": "获取接口调用 token",
        "description": "应用后端用当前 AppSecret 获取 2 小时接口 token；默认在同一密钥代次内返回仍有效的稳定 token，force_refresh=true 会立即吊销旧 token 并签发新 token。应用停用、密钥冻结或密钥重置后不能签发；重置或冻结会在同一事务中吊销旧 token，解冻不会恢复旧 token。AppSecret 只出现在 HTTPS JSON 请求体且不得记录。",
        "tags": [
          "runtime"
        ],
        "security": [],
        "operationId": "issueInterfaceAccessToken",
        "parameters": [
          {
            "$ref": "#/components/parameters/AppID"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InterfaceAccessTokenRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "$ref": "#/components/responses/InterfaceAccessTokenResponse"
          },
          "400": {
            "$ref": "#/components/responses/InvalidRequest"
          },
          "401": {
            "$ref": "#/components/responses/RuntimeUnauthorized"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        }
      }
    }
  },
  "webhooks": {
    "metaEcoBalancePaymentEvent": {
      "post": {
        "summary": "平台向应用后端投递余额支付或退款成功通知",
        "description": "平台向创建支付单时固化的 notify_url 或退款单独指定的 notify_url 发送 HTTPS JSON；同一资金终态对应稳定事件 ID，至少一次投递。接收方必须先使用本应用受信任的 MetaEco 通知公钥验证原始正文，再核对 AppID、业务订单号和金额，并使用应用接口 token 查单确认。成功及已幂等处理的事件应在 5 秒内返回任意 2xx；超时或非 2xx 按退避策略最多尝试 10 次，之后进入死信。重投可有新的时间戳、nonce 和签名，事件正文及 ID 不变。此协议不是微信支付 API v3 通知。",
        "operationId": "receiveMetaEcoBalancePaymentEvent",
        "security": [
          {
            "metaEcoNotificationSignature": []
          }
        ],
        "parameters": [
          {
            "name": "X-MetaEco-Event-ID",
            "in": "header",
            "required": true,
            "description": "必须与正文 id 相同，跨重试不变。",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "X-MetaEco-Key-ID",
            "in": "header",
            "required": true,
            "description": "选择验签公钥，并作为签名串第一行。",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "X-MetaEco-Timestamp",
            "in": "header",
            "required": true,
            "description": "当前投递生成的十进制 Unix 秒；接收方允许的时钟偏差为前后 5 分钟。",
            "schema": {
              "type": "string",
              "pattern": "^[0-9]+$"
            }
          },
          {
            "name": "X-MetaEco-Nonce",
            "in": "header",
            "required": true,
            "description": "当前投递生成的随机字符串。",
            "schema": {
              "type": "string",
              "minLength": 8,
              "maxLength": 64
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/MetaEcoPaymentSucceededEvent"
                  },
                  {
                    "$ref": "#/components/schemas/MetaEcoRefundSucceededEvent"
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "验签并持久化处理或已幂等处理；任何 2xx 均表示确认接收。"
          },
          "204": {
            "description": "验签并持久化处理或已幂等处理；没有响应正文。"
          },
          "400": {
            "description": "通知字段、身份或金额校验失败；平台会重试至死信。"
          },
          "401": {
            "description": "签名、公钥 ID 或时间窗校验失败；平台会重试至死信。"
          },
          "503": {
            "description": "接收方暂时不可用；平台会重试至死信。"
          }
        }
      }
    }
  },
  "components": {
    "parameters": {
      "AppID": {
        "name": "app_id",
        "in": "path",
        "required": true,
        "schema": {
          "type": "string",
          "pattern": "^[a-z][a-z0-9_-]{2,63}$"
        }
      }
    },
    "schemas": {
      "InterfaceAccessTokenRequest": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "app_secret"
        ],
        "properties": {
          "app_secret": {
            "type": "string",
            "pattern": "^msec_[0-9a-f]{64}$",
            "writeOnly": true,
            "description": "当前 AppSecret，仅由应用后端通过 HTTPS 提交且不得记录。"
          },
          "force_refresh": {
            "type": "boolean",
            "default": false,
            "description": "true 时吊销同一密钥代次内仍有效的接口 token 并签发新 token。"
          }
        }
      },
      "SuccessCode": {
        "type": "string",
        "const": "miniapp_success",
        "description": "请求成功时返回的稳定业务码。"
      },
      "InterfaceAccessTokenGrant": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "access_token",
          "expires_in",
          "expires_at"
        ],
        "properties": {
          "access_token": {
            "type": "string",
            "pattern": "^mat_[0-9a-f]{64}$",
            "readOnly": true,
            "description": "仅由应用后端保存的接口 token。"
          },
          "expires_in": {
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "maximum": 7200
          },
          "expires_at": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "ErrorResponse": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "object",
            "required": [
              "code",
              "message"
            ],
            "properties": {
              "code": {
                "type": "string"
              },
              "message": {
                "type": "string"
              },
              "request_id": {
                "type": "string",
                "maxLength": 128,
                "description": "与响应头 X-Request-ID 相同，用于查询服务端失败诊断。"
              },
              "details": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "reason": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      },
      "MetaEcoPaymentSucceededEvent": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "create_time",
          "event_type",
          "resource"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "稳定事件 ID，重复投递时不变。"
          },
          "create_time": {
            "type": "string",
            "format": "date-time"
          },
          "event_type": {
            "type": "string",
            "const": "TRANSACTION.SUCCESS"
          },
          "resource": {
            "$ref": "#/components/schemas/MetaEcoPaymentSucceededResource"
          }
        }
      },
      "MetaEcoPaymentSucceededResource": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "app_id",
          "order_id",
          "business_type",
          "business_order_no",
          "transaction_id",
          "amount_minor",
          "currency",
          "paid_at",
          "status"
        ],
        "properties": {
          "app_id": {
            "type": "string"
          },
          "order_id": {
            "type": "string",
            "format": "uuid"
          },
          "business_type": {
            "type": "string",
            "enum": [
              "trade",
              "shop"
            ]
          },
          "business_order_no": {
            "type": "string"
          },
          "transaction_id": {
            "type": "string"
          },
          "amount_minor": {
            "type": "integer",
            "minimum": 1
          },
          "currency": {
            "type": "string",
            "const": "CNY"
          },
          "paid_at": {
            "type": "string",
            "format": "date-time"
          },
          "status": {
            "type": "string",
            "const": "paid"
          }
        }
      },
      "MetaEcoRefundSucceededEvent": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "create_time",
          "event_type",
          "resource"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "稳定事件 ID，重复投递时不变。"
          },
          "create_time": {
            "type": "string",
            "format": "date-time"
          },
          "event_type": {
            "type": "string",
            "const": "REFUND.SUCCESS"
          },
          "resource": {
            "$ref": "#/components/schemas/MetaEcoRefundSucceededResource"
          }
        }
      },
      "MetaEcoRefundSucceededResource": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "app_id",
          "order_id",
          "business_type",
          "business_order_no",
          "transaction_id",
          "amount_minor",
          "currency",
          "paid_at",
          "refund_id",
          "business_refund_no",
          "refund_amount_minor",
          "refunded_at",
          "status"
        ],
        "properties": {
          "app_id": {
            "type": "string"
          },
          "order_id": {
            "type": "string",
            "format": "uuid"
          },
          "business_type": {
            "type": "string",
            "enum": [
              "trade",
              "shop"
            ]
          },
          "business_order_no": {
            "type": "string"
          },
          "transaction_id": {
            "type": "string"
          },
          "amount_minor": {
            "type": "integer",
            "minimum": 1
          },
          "currency": {
            "type": "string",
            "const": "CNY"
          },
          "paid_at": {
            "type": "string",
            "format": "date-time"
          },
          "refund_id": {
            "type": "string",
            "format": "uuid"
          },
          "business_refund_no": {
            "type": "string"
          },
          "refund_amount_minor": {
            "type": "integer",
            "minimum": 1
          },
          "refunded_at": {
            "type": "string",
            "format": "date-time"
          },
          "status": {
            "type": "string",
            "const": "refunded"
          }
        }
      }
    },
    "responses": {
      "InterfaceAccessTokenResponse": {
        "description": "当前密钥代次内的接口 token；响应禁止缓存。",
        "headers": {
          "Cache-Control": {
            "schema": {
              "type": "string",
              "const": "no-store"
            }
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "code",
                "data"
              ],
              "properties": {
                "code": {
                  "$ref": "#/components/schemas/SuccessCode"
                },
                "data": {
                  "$ref": "#/components/schemas/InterfaceAccessTokenGrant"
                }
              }
            }
          }
        }
      },
      "InvalidRequest": {
        "description": "请求参数无效。",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        }
      },
      "RuntimeUnauthorized": {
        "description": "宿主身份、AppSecret、接口 token 或运行时会话无效。",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        }
      },
      "Conflict": {
        "description": "状态冲突或幂等键冲突。",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        }
      },
      "ServiceUnavailable": {
        "description": "依赖的适配器或存储不可用。",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "metaEcoNotificationSignature": {
        "type": "apiKey",
        "in": "header",
        "name": "X-MetaEco-Signature",
        "description": "Base64 编码的 RSA PKCS#1 v1.5 + SHA-256 签名；签名串为 X-MetaEco-Key-ID、X-MetaEco-Timestamp、X-MetaEco-Nonce、原始 UTF-8 正文逐行连接且正文后再加换行。"
      }
    }
  }
}

返回 API 目录

获取接口调用 token ​

鉴权与参数 ​

请求体 ​

响应 ​

HTTP 200 ​

HTTP 400 ​

HTTP 401 ​

HTTP 409 ​

HTTP 503 ​

完整定义 ​