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.

Sử dụng hướng dẫn này khi bạn đang xây dựng tích hợp phía server, tự động hóa, hoặc AI agent giao tiếp với API V1 công khai của Sellfern.

​
1. Tạo khóa API

Tạo một khóa API có phạm vi trong Sellfern. Sử dụng các phạm vi tối thiểu cần thiết cho quy trình của bạn.

​
2. Lưu trữ khóa an toàn

Lưu khóa trong biến môi trường trên server hoặc trình chạy tự động hóa của bạn. 
export SELLFERN_API_KEY="your_api_key_here"
Không bao giờ commit khóa API vào kho mã nguồn, log, JavaScript phía client, hoặc các prompt được chia sẻ với công cụ bên thứ ba.

​
3. Gửi một yêu cầu

curl https://api.sellfern.com/orders \
  -H "x-api-key: $SELLFERN_API_KEY"

​
4. Xác nhận cô lập tổ chức

Mọi phản hồi đều được giới hạn trong tổ chức gắn với khóa API. Khóa API không được phép lộ hoặc thay đổi dữ liệu của tổ chức khác. Nếu bạn yêu cầu một tài nguyên ngoài tổ chức đó, Sellfern trả về 404 not_found thay vì tiết lộ quyền sở hữu giữa các tổ chức.

​
5. Thêm khóa idempotency cho thao tác ghi

Đối với các yêu cầu POST, PUT, PATCH và DELETE công khai, hãy đính kèm header Idempotency-Key và retry các thất bại mạng hoặc 5xx không chắc chắn với cùng khóa. Endpoint bên dưới chỉ mang tính minh họa. Sử dụng Tham chiếu API V1 để xác nhận endpoint ghi nào có sẵn cho tích hợp của bạn. 
curl https://api.sellfern.com/products \
  -H "x-api-key: $SELLFERN_API_KEY" \
  -H "Idempotency-Key: product-create-001" \
  -H "Content-Type: application/json" \
  -d '{"sku":"TSHIRT-BLACK-M","title":"Classic T-Shirt"}'
Dùng lại cùng một khóa với một yêu cầu khác sẽ trả về 422 idempotency_conflict.

​
6. Dùng Tham chiếu API làm nguồn tin cậy

Tham chiếu API được tạo từ đặc tả OpenAPI V1 công khai đã được Sellfern tuyển chọn. Nếu một endpoint không có ở đó, hãy coi nó là không khả dụng cho các tích hợp công khai.