49 lines
929 B
Markdown
49 lines
929 B
Markdown
# API 参考
|
|
|
|
## 基础地址
|
|
|
|
```
|
|
https://suites.mercator.cn
|
|
```
|
|
|
|
## 认证
|
|
|
|
```bash
|
|
Authorization: Bearer mk_xxxxxxxxxxxxx
|
|
```
|
|
|
|
API Key 从 https://auth.mercator.cn 获取。
|
|
|
|
## 套件 API
|
|
|
|
| 方法 | 端点 | 说明 |
|
|
|------|------|------|
|
|
| GET | `/api/v1/suites` | 套件列表 |
|
|
| GET | `/api/v1/suites/{id}` | 套件详情 |
|
|
| PATCH | `/api/v1/suites/{id}` | 更新套件 |
|
|
|
|
## 发布 API
|
|
|
|
| 方法 | 端点 | 说明 |
|
|
|------|------|------|
|
|
| POST | `/api/v1/publish` | 发布套件（JSON 提交） |
|
|
|
|
## 完整文档
|
|
|
|
自动生成的全量 API 文档：
|
|
[https://suites.mercator.cn/docs](https://suites.mercator.cn/docs)
|
|
|
|
## 错误码
|
|
|
|
| 状态码 | 说明 |
|
|
|--------|------|
|
|
| 200 | 成功 |
|
|
| 201 | 创建成功 |
|
|
| 400 | 请求参数错误 |
|
|
| 401 | 未认证或 API Key 无效 |
|
|
| 403 | 权限不足 |
|
|
| 404 | 资源不存在 |
|
|
| 409 | 资源冲突 |
|
|
| 422 | 参数校验失败 |
|
|
| 500 | 服务器内部错误 |
|