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.

Sellfern được thiết kế để rõ ràng đối với AI agent, công cụ tự động hóa và nhà phát triển. Hướng dẫn này giải thích cách một agent nên khám phá tài liệu có sẵn, chọn hành động an toàn và tránh hành vi API không được hỗ trợ.

​
Bắt đầu với chỉ mục tài liệu

Agent nên bắt đầu với: 
https://docs.sellfern.com/llms.txt
Sử dụng chỉ mục đó để khám phá các trang sản phẩm, hướng dẫn cho nhà phát triển và Tham chiếu API trước khi đưa ra giả định.

​
Chỉ dùng các endpoint công khai sẵn sàng cho V1

Tham chiếu API được tạo từ đặc tả OpenAPI V1 công khai đã được Sellfern tuyển chọn. Hãy xem đó là nguồn tin cậy duy nhất về sự sẵn có của endpoint công khai. Nếu một endpoint không có trong Tham chiếu API, hãy coi nó là không khả dụng cho các tích hợp công khai.

​
Xác thực

Sử dụng khóa API có phạm vi với header x-api-key: 
curl https://api.sellfern.com/orders \
  -H "x-api-key: $SELLFERN_API_KEY"
Không bao giờ dùng JWT phiên trình duyệt cho các tích hợp server-to-server.

​
Phạm vi (scope)

Yêu cầu phạm vi tối thiểu cần thiết cho mục tiêu của người dùng. Nếu Sellfern trả về 403 missing_scope, hãy yêu cầu người dùng cung cấp khóa API có thêm phạm vi tối thiểu cần thiết.

​
Cô lập tổ chức

Khóa API được giới hạn trong một tổ chức. Nếu Sellfern trả về 404 not_found, đừng suy luận rằng tài nguyên tồn tại trong một tổ chức khác.

​
Ghi và thử lại

Đối với các endpoint ghi công khai, hãy gửi header Idempotency-Key. Sử dụng lại cùng một khóa khi thử lại cùng một thao tác logic sau khi hết thời gian chờ hoặc phản hồi 5xx không chắc chắn. Tạo khóa mới cho một thao tác logic khác.

​
Tránh các bề mặt không khả dụng

Không sử dụng hoặc đề xuất các endpoint quản trị, gỡ lỗi, cron, nội bộ, hàng loạt trì hoãn, đồng bộ, nhập liệu, xử lý đơn, tài chính diện rộng hoặc không công khai trừ khi chúng xuất hiện trong Tham chiếu API V1.

​
Quy trình được khuyến nghị

  1. Đọc llms.txt.
  2. Đọc trang sản phẩm liên quan để hiểu ý định của người dùng.
  3. Đọc hướng dẫn cho nhà phát triển liên quan về xác thực, lỗi, idempotency và phạm vi.
  4. Xác nhận sự khả dụng của endpoint trong Tham chiếu API.
  5. Sử dụng lệnh gọi API tối thiểu cần thiết.
  6. Giải thích cho người dùng bất kỳ phạm vi bị thiếu, endpoint không khả dụng hoặc yêu cầu không an toàn nào trước khi tiếp tục.