API 文档
了解如何集成 Mercozy API 来管理商品、订单、库存等。
快速开始
1
获取 API 密钥
以管理员身份登录，前往 设置 > 集成 > API 密钥 生成新密钥。仅管理员有权操作。
2
在请求中包含密钥
在所有 API 请求中添加 X-API-Key 头。
3
开始发送请求
使用任意 HTTP 客户端与 Mercozy API 接口交互。
身份认证
所有 API 请求都需要通过 X-API-Key 头发送有效的 API 密钥。
bash
curl https://api.mercozy.com/api/v1/external/products \
-H "X-API-Key: mk_live_your_key_here"API 密钥绑定到您的租户。请妥善保管，切勿在客户端代码中暴露。
基础 URL
https://api.mercozy.com/api/v1/external速率限制
API 速率限制取决于您的订阅计划。
| 计划 | 速率限制 | API 访问 |
|---|---|---|
| Free / Standard | 无 API 访问 | No |
| Pro | 300 请求/分钟 | Yes |
| Business | 1,000 请求/分钟 | Yes |
响应格式
所有响应均以 JSON 格式返回。
成功响应
json
{
"data": [
{
"id": "prod_abc123",
"name": "Premium Widget",
"price": 2999,
"currency": "USD"
}
],
"meta": {
"total": 42,
"page": 1,
"limit": 20
}
}错误响应
json
{
"statusCode": 401,
"message": "Invalid API key",
"error": "Unauthorized"
}错误码
| 错误码 | 状态码 | 描述 |
|---|---|---|
VALIDATION_ERROR | 400 | 请求参数无效 |
UNAUTHORIZED | 401 | API 密钥无效或缺失 |
FORBIDDEN | 403 | 权限不足 |
NOT_FOUND | 404 | 资源未找到 |
CONFLICT | 409 | 资源已存在或发生冲突 |
RATE_LIMITED | 429 | 请求过于频繁 |
INTERNAL_ERROR | 500 | 服务器内部错误 |