Bỏ qua điều hướng
Bắt đầu › Tổng quan

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.

địa chỉ gốc
https://api.modernengineer.dev

Xá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 choHạ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 /mcp300 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.

application/json
{
  "error": {
    "code": "not_found",
    "message": "Content item was not found",
    "requestId": "…"
  }
}
MãLỗi
400invalid_input
401unauthenticated
403forbidden
403insufficient_scope
404not_found
405method_not_allowed
409conflict
422unprocessable
429too_many_requests
500internal_error
503service_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.

mcp.json
{
  "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.

VerbRESTTool MCPQuyền
catalog.listGET /catalogcatalog_listKhông cần key
catalog.getGET /catalog/{locale}/{slug}catalog_getKhông cần key
articles.listGET /articlesarticles_listKhông cần key
articles.getGET /articles/{locale}/{slug}articles_getCần key
content.listGET /contentcontent_listCần key
content.searchGET /content/searchcontent_searchKhông cần key
content.getGET /content/{locale}/{slug}content_getCần key
packs.downloadPOST /packs/{slug}/downloadpacks_downloadCần key
pack-versions.getGET /pack-versions/{slug}pack-versions_getKhông cần key
visuals.issueUrlPOST /visuals/{locale}/{slug}/urlvisuals_issueUrlCần key
visuals.issueFlowUrlPOST /visuals/{locale}/{slug}/flow/urlvisuals_issueFlowUrlCần key
visuals.issueMotionUrlPOST /visuals/{locale}/{slug}/motion/urlvisuals_issueMotionUrlCần key
spotlight.listGET /spotlightspotlight_listKhông cần key
prices.listGET /pricesprices_listKhông cần key
orders.quotePOST /orders/quoteorders_quoteCần key
orders.createPOST /ordersorders_createCần key
orders.listGET /ordersorders_listCần key
orders.getGET /orders/{code}orders_getCần key
claims.redeemPOST /claims/facebookclaims_redeemCần key
entitlements.statusGET /entitlements/statusentitlements_statusCần key
preferences.getGET /preferencespreferences_getCần key
preferences.updatePATCH /preferencespreferences_updateCần key