Kinh doanhBảo vệ thanh toánChi tiết
- Chỉnh sửa trong phạm vi gói là miễn phí.
- Nếu bạn không phản hồi trong vòng 3 ngày sau khi bàn giao, kết quả sẽ được tự động chấp nhận.
Số tiền được tạm giữ khi bạn thanh toán và chỉ được chuyển khi bạn chấp nhận kết quả.

Ví dụ kết quả
Tài liệu API: API theo dõi bưu kiện cho cửa hàng online
Bắt đầu nhanh
- Lấy API key tại Dashboard → Settings → API keys.
- Gửi mọi request kèm header
Authorization: Bearer <your_key>. - Base URL:
https://api.trackpoint.example/v1
Lấy thông tin lô hàng
GET /shipments/{tracking_number}
Trả về trạng thái hiện tại và lịch sử sự kiện của một bưu kiện.
| Tham số | Vị trí | Bắt buộc | Mô tả |
|---|---|---|---|
| tracking_number | path | có | Mã vận đơn của hãng vận chuyển, 8–30 ký tự |
| lang | query | không | Ngôn ngữ của trạng thái: en, de, fr. Mặc định: en |
Request mẫu
curl https://api.trackpoint.example/v1/shipments/JD014600006281 \
-H "Authorization: Bearer sk_test_51x..."
Response mẫu (200)
{
"tracking_number": "JD014600006281",
"status": "in_transit",
"estimated_delivery": "2026-11-19",
"events": [
{"time": "2026-11-16T08:42:00Z", "location": "Leipzig hub", "status": "in_transit"}
]
}
Lỗi
| Mã | Ý nghĩa | Cách xử lý |
|---|---|---|
| 401 | Thiếu hoặc sai API key | Kiểm tra header Authorization |
| 404 | Không tìm thấy mã vận đơn | Hãng vận chuyển có thể mất đến 2 giờ để ghi nhận bưu kiện mới |
| 429 | Quá 100 request mỗi phút | Chờ theo thời gian trong header Retry-After |
Bàn giao
Tài liệu cho cả 14 endpoint dạng Markdown, sẵn sàng đưa lên trang tài liệu của khách, và danh sách 3 chỗ API hoạt động khác với mô tả, đã gửi cho đội lập trình.
Khách hàng: Trackpoint, startup có REST API giúp cửa hàng online hiển thị trạng thái bưu kiện; đội lập trình gửi mô tả ngắn của 14 endpoint và một bộ request mẫu Yêu cầu: hướng dẫn bắt đầu nhanh và tài liệu tham chiếu endpoint mà lập trình viên làm theo được trong 15 phút; trích đoạn bên dưới
Khách hàng và mọi thông tin đều là giả định.
Về dịch vụ này
Lập trình viên đánh giá một API qua tài liệu chỉ trong vài phút: nếu xác thực hoặc yêu cầu đầu tiên không chạy, họ sẽ rời đi. Chúng tôi viết tài liệu tham chiếu và hướng dẫn API từ mô tả endpoint, tệp OpenAPI hoặc mã mẫu của bạn: xác thực, base URL, từng endpoint với tham số, ví dụ request và response, mã lỗi, giới hạn tần suất và phân trang. Phần bắt đầu nhanh hướng dẫn lệnh gọi thành công đầu tiên trong vài bước.
Bao gồm những gì
- Bạn nhận được gìTài liệu API dạng Markdown với các khối mã, sẵn sàng cho ReadMe, GitBook, Docusaurus hoặc repository của bạn. Chúng tôi viết từ những gì bạn gửi, không tự gọi API của bạn.
- Bắt đầu nhanhTừ khóa API đến lệnh gọi đầu tiên
- Tham chiếu endpointTham số, kiểu dữ liệu, ví dụ
- Lỗi và giới hạnMã lỗi, ý nghĩa, lời khuyên thử lại
- Mã mẫucURL cùng một ngôn ngữ bạn chọn
- Thuật ngữ nhất quánCùng tên như trong schema của bạn
Cách hoạt động
- 1Yêu cầuBạn dán hoặc đính kèm endpoint và ví dụ
- 2Cấu trúc và nội dungChúng tôi viết tài liệu tham chiếu và hướng dẫn
- 3Bàn giaoBạn nhận Markdown sẵn sàng xuất bản
Chúng tôi cần gì từ bạn
Mô tả endpoint hoặc tệp OpenAPI hay Postman dán dưới dạng văn bản, thông tin xác thực, ví dụ request và response, mã lỗi và người dùng API của bạn là ai.
Chúng tôi sẽ hỏi bạn:
- API làm gì và ai sử dụng?
- Xác thực hoạt động thế nào?
- Ngoài cURL, mã mẫu nên dùng ngôn ngữ nào?
- Tài liệu sẽ được xuất bản ở đâu?
So sánh các gói
| Các gói | Cơ bản515.000 ₫ | Tiêu chuẩn1.057.000 ₫ | Cao cấp2.141.000 ₫ |
|---|---|---|---|
| Bao gồm những gì | Bắt đầu nhanh và tối đa 5 endpoint | Tối đa 20 endpoint kèm hướng dẫn | Tối đa 50 endpoint, tài liệu đầy đủ |
| Thời hạn | 1 ngày | 3 ngày | 5 ngày |
| Số lần chỉnh sửa | 1 | 2 | 3 |
| Độ dài | tối đa 2.000 từ | tối đa 6.000 từ | tối đa 14.000 từ |
| Endpoint | tối đa 5 | tối đa 20 | tối đa 50 |
| Ngôn ngữ mã mẫu | cURL | cURL + 1 | cURL + 2 |
| Đặt hàng Cơ bản | Đặt hàng Tiêu chuẩn | Đặt hàng Cao cấp |
Bảo vệ thanh toán
Bạn thanh toán khi đặt hàng, nhưng tiền chỉ được chuyển cho kết quả đã được chấp nhận.
- Giá cố địnhGiá gói không thay đổi sau khi bạn thanh toán.
- Số tiền được tạm giữKhi bạn thanh toán, số tiền chỉ được tạm giữ. Tiền được chuyển cho dịch vụ khi bạn chấp nhận kết quả.
- Kiểm tra trước khi bàn giaoMọi kết quả đều được kiểm tra chất lượng trước khi đến tay bạn, và bạn xem được kết quả trên trang đơn hàng trước khi chấp nhận.
- Chỉnh sửa miễn phíYêu cầu chỉnh sửa trong phạm vi bản yêu cầu của bạn, với số lần mà gói cho phép.
- Tự động chấp nhận sau 3 ngàyNếu trong vòng 3 ngày sau khi bàn giao, bạn không chấp nhận kết quả cũng không yêu cầu chỉnh sửa, kết quả sẽ được tự động chấp nhận. Nếu bạn nhắn tin trong chat đơn hàng sau khi bàn giao, đơn hàng sẽ chờ; sau khi trả lời, chúng tôi có thể tính lại 3 ngày từ đầu và sẽ thông báo trong chat.
- Làm lại hoặc hoàn tiền toàn bộNếu kết quả không đúng với yêu cầu của bạn và các lần chỉnh sửa không khắc phục được, hoặc công việc kéo dài quá gấp đôi thời hạn, hãy nhắn tin trong chat đơn hàng: chúng tôi sẽ làm lại hoặc hoàn tiền toàn bộ.
Hỏi đáp
Các bạn có thể làm từ đặc tả OpenAPI của chúng tôi không?
Có, hãy dán YAML hoặc JSON vào yêu cầu. Chúng tôi chuyển phần mô tả trong đó thành các trang tham chiếu dễ đọc và bổ sung những chỗ trống bạn chỉ ra.
Các bạn có kiểm tra các ví dụ không?
Chúng tôi không gọi API của bạn. Ví dụ được xây dựng từ mẫu request và response của bạn, vì vậy hãy chạy thử một lần trước khi xuất bản.
Các bạn có viết tài liệu SDK không?
Có, nếu bạn gửi chữ ký phương thức và ví dụ sử dụng. Mỗi SDK được tính vào khối lượng của gói.
Chưa tìm thấy câu trả lời?


