商業
成果範例
API documentation: a parcel tracking API for online stores
Quick start
- Get your API key in Dashboard → Settings → API keys.
- Send every request with the header
Authorization: Bearer <your_key>. - Base URL:
https://api.trackpoint.example/v1
Get a shipment
GET /shipments/{tracking_number}
Returns the current status and event history of one parcel.
| Parameter | In | Required | Description |
|---|---|---|---|
| tracking_number | path | yes | Carrier tracking number, 8–30 characters |
| lang | query | no | Language of status texts: en, de, fr. Default: en |
Example request
curl https://api.trackpoint.example/v1/shipments/JD014600006281 \
-H "Authorization: Bearer sk_test_51x..."
Example response (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"}
]
}
Errors
| Code | Meaning | What to do |
|---|---|---|
| 401 | Missing or wrong API key | Check the Authorization header |
| 404 | Tracking number not found | Carriers can take up to 2 hours to register a new parcel |
| 429 | More than 100 requests a minute | Wait for the time given in the Retry-After header |
Delivered
Docs for all 14 endpoints in Markdown, ready for the client's docs site, and a list of 3 places where the API behaved differently from the descriptions, sent to the developers.
Client: Trackpoint, a startup whose REST API lets online stores show parcel status; the developers sent short descriptions of 14 endpoints and a set of sample requests Task: a quick start and an endpoint reference a developer can follow in 15 minutes; an excerpt is below
客戶與所有細節皆為虛構。
關於此服務
開發人員幾分鐘內就會根據文件判斷一個 API 的好壞:如果驗證或第一次請求無法成功,他們就離開了。我們依據您的端點說明、OpenAPI 檔案或程式碼範例撰寫 API 參考與指南:驗證方式、基礎 URL、含參數的各個端點、請求與回應範例、錯誤碼、速率限制與分頁。快速入門只需幾個步驟,就能完成第一次成功呼叫。
包含內容
- 您會收到什麼含程式碼區塊的 Markdown 格式 API 文件,可用於 ReadMe、GitBook、Docusaurus 或您的程式碼儲存庫。我們依據您提供的內容撰寫,不會自行呼叫您的 API。
- 快速入門從 API 金鑰到第一次呼叫
- 端點參考參數、型別、範例
- 錯誤與限制代碼、意義、重試建議
- 程式碼範例cURL 加上您選擇的一種語言
- 用語一致與您的結構描述名稱相同
服務流程
- 1需求說明您貼上或附上端點與範例
- 2架構與撰寫我們撰寫參考文件與指南
- 3交付您會收到可直接發布的 Markdown
需要您提供的資料
以文字貼上的端點說明或 OpenAPI、Postman 檔案、驗證細節、請求與回應範例、錯誤碼,以及您的 API 使用者是誰。
我們會詢問您:
- 這個 API 的功能是什麼?誰在使用?
- 驗證如何運作?
- 除了 cURL,程式碼範例要用哪種語言?
- 文件將發布在哪裡?
比較方案
付款保障
下單時付款,但只有在驗收成果後,款項才會撥付。
- 固定價格付款後,方案價格不會變動。
- 款項先行保留付款時,金額只會先保留,在您驗收後才會撥付給服務。
- 交付前檢查每份成果在交到您手上之前都會經過品質檢查,您也可以在驗收前於訂單頁面查看成果。
- 免費修改在需求說明範圍內,可依方案允許的次數提出修改。
- 3 天後自動驗收若您在交付後 3 天內未驗收也未提出修改,成果將自動驗收。若您在交付後於訂單聊天室留言,訂單會暫停自動驗收;我們回覆後,可能會重新起算 3 天,並會在聊天室中告知。
- 重新製作或全額退款若成果不符合您的需求說明且修改後仍未改善,或製作時間超過交付期限的兩倍,請在訂單聊天室留言:我們將重新製作,或全額退還款項。
常見問題
你們可以依據我們的 OpenAPI 規格來撰寫嗎?
可以,請將 YAML 或 JSON 貼入需求說明。我們會將其中的描述整理成易讀的參考頁面,並補上您指出的缺漏。
你們會測試範例嗎?
我們不會呼叫您的 API。範例依據您提供的請求與回應樣本建立,因此發布前請先自行執行一次。
你們會撰寫 SDK 文件嗎?
會,只要您提供方法簽章與使用範例。每個 SDK 都計入方案的內容量。
沒有找到您要的答案?


