---
title: "APayShop 开发指南"
canonical_url: "https://gopanel.dev/zh-HK/docs"
type: "doc"
locale: "zh-HK"
description: "欢迎使用 APayShop 开发者文档"
---

# APayShop 开发指南
> 欢迎使用 APayShop 开发者文档

欢迎来到 APayShop 开发者文档中心。APayShop 是一个专为**虚拟商品（卡密、数字文件、服务订阅、人工代充、动态API）**设计的极客风全栈独立站系统。

在这里，你可以了解系统的核心架构、各种商品类型的履约机制，以及如何通过 API 与 APayShop 进行集成。

## 核心架构特性

APayShop 采用了极简但强大的现代化架构：

- **极致轻量**: 基于 Nuxt 4 + 本地 SQLite (NuxtHub) 构建，无外部依赖，支持一键部署。
- **动态模板引擎**: 系统支持多模板热切换，无需修改核心代码即可更换前台 UI。
- **主题后台扩展**: 当前激活主题可以通过统一的 `/admin/extensions/*` 命名空间注册自己的后台扩展页。
- **沙箱支付回调**: 支付网关采用插件化设计，解析逻辑以纯 JS 代码形式存储，在沙箱环境中安全运行。
- **全场景履约引擎**: 支持 5 大核心商品类型，涵盖了绝大多数虚拟商品交易场景。

## 面向人群

本指南主要面向：

1. **二次开发者**: 希望基于 APayShop 进行二次开发、增加新功能或编写新模板的工程师。
2. **API 集成者**: 希望通过 API 对接 APayShop（如购买 Dynamic API 产品后调用对应接口）的用户。
3. **系统管理员**: 需要了解系统底层机制（如商品类型配置、订单流转）以更好地运营网站的站长。

## 开始使用

请在左侧导航栏中选择您感兴趣的模块。如果您是初次接触，建议先阅读 **产品与履约机制** 章节。如果您正在开发模板后台能力，也建议继续阅读 **主题后台扩展机制** 章节。

---

## 基础 API 约定

如果你需要调用系统的开放 API（如购买的 `dynamic_api` 产品），请遵循以下基础约定。

### 基础 URL

所有的 API 请求都应该基于您部署网站的域名：

```http
GET https://yourdomain.com/api
```

### 响应格式

所有 API 的响应均为 JSON 格式。成功时通常会包含请求的数据：

```json
{
  "id": 123,
  "status": "success",
  "data": { ... }
}
```

### 错误处理

发生错误时，API 会返回对应的 HTTP 状态码（如 400, 401, 404, 500），并附带包含错误详情的 JSON 响应：

```json
{
  "statusCode": 401,
  "statusMessage": "Unauthorized",
  "message": "Invalid API key provided."
}
```