Tài liệu

Tài liệu

Tài liệu tham khảo kỹ thuật cho các tích hợp, API và hướng dẫn phát triển của Deckbase.

Tham khảo

Liên kết nhanh

Bắt đầu nhanh

curl -X POST https://www.deckbase.co/api/mcp \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","method":"tools/list","id":1}'

Thay thế YOUR_ACCESS_TOKEN bằng mã thông báo OAuth từ Trang Kết nối. Để xem hướng dẫn thiết lập, hãy xem hướng dẫn thiết lập MCP.

Tổng quan API

Deckbase cung cấp hai cách tích hợp: máy chủ MCP để quản lý bộ thẻ và thẻ có sự hỗ trợ của AI, cùng các điểm cuối REST API trực tiếp để truy cập bằng chương trình.

  • Tạo, cập nhật và xóa bộ thẻ và thẻ theo lô
  • Tạo âm thanh và hình ảnh AI cho thẻ thông qua ElevenLabs và các mô hình hình ảnh
  • Xuất toàn bộ dữ liệu bộ thẻ bao gồm bản chụp khối và siêu dữ liệu
  • Xây dựng mẫu tùy chỉnh với bố cục khối linh hoạt
  • Nhận sự kiện webhook khi bộ thẻ và thẻ thay đổi

Bắt đầu tại đây

Thực hành tốt nhất

Coi việc tạo thẻ như một quy trình vận hành

Lưu nhật ký yêu cầu, xác thực các trường mẫu bắt buộc trước khi ghi và kiểm tra ngẫu nhiên thẻ được tạo trước khi tăng kích thước lô.

Xác định một chiến lược mẫu chuẩn

Với nhóm, hãy xác định một chiến lược mẫu chuẩn và một chính sách thử lại. Điều này tránh tình trạng lời nhắc bị trôi lệch và trùng lặp, đồng thời giúp xử lý sự cố nhanh hơn nhiều khi quy tắc ánh xạ thay đổi.

Tuân theo thứ tự đọc được đề xuất

Trang thiết lập trước, tham chiếu Máy chủ MCP sau, rồi đến kiểm tra triển khai sản xuất. Lộ trình này giảm thiểu lỗi xác thực và lỗi không khớp lược đồ khi tạo thẻ.

Ghi lại quy tắc trong repo của bạn

Nếu bạn đang triển khai quy trình làm việc cho nhóm, hãy ghi lại quy tắc mẫu và các cổng chấp nhận lô ngay trong repo để các cập nhật sau này luôn nhất quán.

Thực hiện đánh giá vận hành hằng tuần

Kiểm tra các lỗi ghi gần đây, mẫu bị trôi lệch và tỷ lệ lời nhắc trùng lặp trước khi mở rộng khối lượng tự động hóa.

Đánh phiên bản danh sách kiểm tra tích hợp của bạn

Giữ danh sách kiểm tra tích hợp có phiên bản để việc giới thiệu người đóng góp mới không cần phải suy ngược các quyết định thiết lập MCP trước đây.

Bao gồm sổ tay hoàn tác

Khi có thể, hãy bao gồm một sổ tay ngắn để hoàn tác và xử lý lại các lô thất bại để các bản cập nhật sản xuất vẫn an toàn ngay cả khi mẫu thay đổi.

Câu hỏi thường gặp

Để xem hướng dẫn và bài viết, hãy xem Tài nguyên