Chuyển đến nội dung chính

Documentation Index

Fetch the complete documentation index at: https://docs.sellfern.com/llms.txt

Use this file to discover all available pages before exploring further.

Mỗi token API Sellfern được cấp các phạm vi cụ thể kiểm soát các điểm cuối nào nó có thể gọi. Giới hạn token một cách hẹp giới hạn phạm vi hậu quả nếu một token bị rò rỉ — một token phân tích chỉ đọc không thể sửa đổi đơn hàng ngay cả khi bị xâm phạm.

Tham chiếu phạm vi

Phạm viMô tả
orders:readĐọc đơn hàng, chi tiết đơn hàng, ghi chú và thông tin theo dõi.
orders:writeTạo hoặc cập nhật đơn hàng và thêm ghi chú đơn hàng.
orders:status:writeCập nhật trạng thái đơn hàng (đơn lẻ hoặc hàng loạt).
analytics:readĐọc tóm tắt phân tích và báo cáo theo từng cửa hàng.
fulfillment:readĐọc hàng đợi hoàn tất đơn và trạng thái hoàn tất đơn.
fulfillment:writeGán nhà cung cấp và cập nhật bản ghi hoàn tất đơn.
webhooks:manageTạo, liệt kê, cập nhật, thử nghiệm và xóa các điểm cuối webhook.

Chọn phạm vi cho các trường hợp sử dụng phổ biến

Bot phân tích chỉ đọc Chỉ cấp analytics:read. Token có thể gọi /api/v2/analytics/summary/api/v2/analytics/by-store nhưng không thể chạm vào đơn hàng hoặc hoàn tất đơn. Trình cập nhật trạng thái đơn hàng Cấp orders:readorders:status:write. Token có thể liệt kê đơn hàng và cập nhật trạng thái của chúng, nhưng không thể tạo đơn hàng, thêm ghi chú hoặc truy cập hoàn tất đơn. Agent tự động hóa đầy đủ Cấp orders:read, orders:write, orders:status:write, analytics:read, fulfillment:readfulfillment:write. Chỉ sử dụng bộ phạm vi này cho các agent đáng tin cậy cần quyền truy cập vận hành đầy đủ. Script thiết lập webhook Chỉ cấp webhooks:manage. Token có thể đăng ký và quản lý các điểm cuối webhook mà không có quyền truy cập vào dữ liệu đơn hàng hoặc phân tích.

Kiểm tra phạm vi có sẵn qua API

Bạn có thể lấy danh sách hiện tại của các phạm vi hợp lệ bất cứ lúc nào:
GET https://api.sellfern.com/api/v2/scopes
Tuân theo nguyên tắc đặc quyền tối thiểu: bắt đầu với bộ phạm vi hẹp nhất khiến tích hợp của bạn hoạt động, và chỉ thêm nhiều hơn nếu một điểm cuối cụ thể trả về 403 missing_scope. Bạn luôn có thể tạo một token mới với phạm vi rộng hơn khi yêu cầu của bạn tăng.