---
title: "APayShop Developer Guide"
canonical_url: "https://gopanel.dev/ja/docs"
type: "doc"
locale: "ja"
description: "Welcome to the APayShop developer documentation"
---

# APayShop Developer Guide
> Welcome to the APayShop developer documentation

Welcome to the APayShop developer documentation center. APayShop is a full-stack, geek-style independent store system designed specifically for **virtual products (keys, digital files, service subscriptions, manual top-ups, dynamic APIs)**.

Here, you can learn about the core architecture of the system, the fulfillment mechanisms of various product types, and how to integrate with APayShop via API.

## Core Architecture Features

APayShop adopts a minimalist yet powerful modern architecture:

- **Ultra-lightweight**: Built on Nuxt 4 + local SQLite (NuxtHub), zero external dependencies, supporting one-click deployment.
- **Dynamic Template Engine**: The system supports hot-switching of multiple themes without modifying core code to change the frontend UI.
- **Theme Admin Extensions**: Active themes can now register their own admin extension pages under a unified `/admin/extensions/*` namespace.
- **Sandbox Payment Callback**: Payment gateways use a plug-in design, parsing logic is stored as pure JS code, and runs safely in a sandbox environment.
- **Full-scenario Fulfillment Engine**: Supports 5 core product types, covering the vast majority of virtual product trading scenarios.

## Target Audience

This guide is primarily for:

1. **Secondary Developers**: Engineers who want to perform secondary development, add new features, or write new themes based on APayShop.
2. **API Integrators**: Users who want to connect to APayShop via API (e.g., calling corresponding interfaces after purchasing Dynamic API products).
3. **System Administrators**: Webmasters who need to understand the underlying mechanisms of the system (such as product type configuration, order flow) to better operate the website.

## Getting Started

Please select the module you are interested in from the left navigation bar. If you are new here, it is recommended to read the **Product & Fulfillment Mechanism** chapter first. If you are building custom storefront operations, also review the **Theme Admin Extensions** chapter.

---

## Basic API Conventions

If you need to call the system's open API (such as the purchased `dynamic_api` product), please follow the basic conventions below.

### Base URL

All API requests should be based on the domain name of your deployed website:

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

### Response Format

All API responses are in JSON format. Upon success, it usually contains the requested data:

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

### Error Handling

When an error occurs, the API will return the corresponding HTTP status code (e.g., 400, 401, 404, 500), accompanied by a JSON response containing error details:

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