Tài liệu API
Cùng một API, hai đường vào: REST cho script, MCP cho agent. Danh mục bài, bảng giá và mục trang chủ không cần key; đọc guide subscriber, đặt đơn chuyển khoản và xem quyền của tài khoản cần API key.
Tổng quan
Mọi đường dẫn bên dưới tính từ địa chỉ gốc này. Phản hồi là JSON.
https://api.modernengineer.devXác thực
Tạo API key trong Quản lý API key, rồi gửi kèm header Authorization: Bearer <key>. Key chỉ hiện một lần lúc tạo. Các verb public (catalog, articles.list, pack-versions, spotlight, prices) không cần key. Verb POST và PATCH nhận tham số trong body JSON, kèm header Content-Type: application/json.
Hạn mức & lỗi
| Áp dụng cho | Hạn mức |
|---|---|
| Đọc guide trả phí (content.get) | 1.000 lần trong 24 giờ, theo tài khoản |
| Link tải bộ file và link hình (packs.download, visuals.issueUrl) | 50 link trong 24 giờ, theo tài khoản |
| Tạo đơn chuyển khoản (orders.create) | 20 đơn mỗi giờ, theo tài khoản |
| Báo giá với mã giảm giá (orders.quote) | 30 lần mỗi giờ, theo tài khoản |
| Đổi mã claim Facebook (claims.redeem) | 10 lần mỗi giờ, theo tài khoản |
| Endpoint /mcp | 300 lần mỗi phút, theo IP |
Mọi lỗi trả về cùng một dạng JSON, kèm requestId để báo lỗi. Có thể có thêm details: invalid_input liệt kê trường bị từ chối trong details.issues, unprocessable ghi lý do trong details.reason.
{
"error": {
"code": "not_found",
"message": "Content item was not found",
"requestId": "…"
}
}| Mã | Lỗi |
|---|---|
| 400 | invalid_input |
| 401 | unauthenticated |
| 403 | forbidden |
| 403 | insufficient_scope |
| 404 | not_found |
| 405 | method_not_allowed |
| 409 | conflict |
| 422 | unprocessable |
| 429 | too_many_requests |
| 500 | internal_error |
| 503 | service_unavailable |
Cài đặt MCP
Khai báo một lần trong client MCP, thay <API key> bằng key bạn đã tạo (file JSON không tự thay biến môi trường; client nào có cú pháp biến riêng thì dùng cú pháp đó). Dùng cùng API key với REST.
{
"mcpServers": {
"modernengineer": {
"type": "http",
"url": "https://api.modernengineer.dev/mcp",
"headers": {
"Authorization": "Bearer <API key>"
}
}
}
}Danh sách tool
Mọi verb một API key gọi được. Mỗi verb có một đường REST và một tool MCP cùng tham số. Quản lý API key, ứng dụng đã kết nối và thanh toán thẻ thuộc trang tài khoản trên web: tools/list của một API key không có các tool này, nên trang này không ghi.
| Verb | REST | Tool MCP | Quyền |
|---|---|---|---|
| catalog.list | GET /catalog | catalog_list | Không cần key |
| catalog.get | GET /catalog/{locale}/{slug} | catalog_get | Không cần key |
| articles.list | GET /articles | articles_list | Không cần key |
| articles.get | GET /articles/{locale}/{slug} | articles_get | Cần key |
| content.list | GET /content | content_list | Cần key |
| content.search | GET /content/search | content_search | Không cần key |
| content.get | GET /content/{locale}/{slug} | content_get | Cần key |
| packs.download | POST /packs/{slug}/download | packs_download | Cần key |
| pack-versions.get | GET /pack-versions/{slug} | pack-versions_get | Không cần key |
| visuals.issueUrl | POST /visuals/{locale}/{slug}/url | visuals_issueUrl | Cần key |
| visuals.issueFlowUrl | POST /visuals/{locale}/{slug}/flow/url | visuals_issueFlowUrl | Cần key |
| visuals.issueMotionUrl | POST /visuals/{locale}/{slug}/motion/url | visuals_issueMotionUrl | Cần key |
| spotlight.list | GET /spotlight | spotlight_list | Không cần key |
| prices.list | GET /prices | prices_list | Không cần key |
| orders.quote | POST /orders/quote | orders_quote | Cần key |
| orders.create | POST /orders | orders_create | Cần key |
| orders.list | GET /orders | orders_list | Cần key |
| orders.get | GET /orders/{code} | orders_get | Cần key |
| claims.redeem | POST /claims/facebook | claims_redeem | Cần key |
| entitlements.status | GET /entitlements/status | entitlements_status | Cần key |
| preferences.get | GET /preferences | preferences_get | Cần key |
| preferences.update | PATCH /preferences | preferences_update | Cần key |