One self-hosted console to run your entire business — commerce, ERP, HRM, CRM & manufacturing

REST API 概述

REST API 概述

该平台在/api/下提供全面的 REST API,允许您构建自定义商店前端、移动应用、第三方集成和自动化脚本。

认证

API 使用Laravel Sanctum进行基于令牌的认证。

获取令牌

POST /api/auth/login
Content-Type: application/json

{
  "email": "[email protected]",
  "password": "your-password"
}

响应包含token字段。将其作为 Bearer 令牌传递在后续请求中:

Authorization: Bearer {your-token}

响应格式

所有响应使用一致的封装:

{
  "status": true,
  "message": "产品成功检索",
  "data": { ... }
}

验证错误返回 HTTP 422,包含errors对象。

版本控制

API 通过 URL 前缀进行版本控制。当前稳定版本为/api/v1/。破坏性更改仅在新版本中引入。

速率限制

API 请求的速率限制为每个经过认证的用户每分钟 60 次请求。超过此限制将返回 HTTP 429,并带有Retry-After头部。

Last updated: 8/27/2026