集運 API 開發者平台:用你自己的金鑰讀取集運與報關資料

免人工審查的集運 API——加「好運器集運官方帳號」LINE 好友即可自助申請金鑰,讓你的系統、OpenClaw 或 Hermes 直接讀取自己的帳單、包裹、預報與稅單。會員事件的 Webhook 推送仍在規劃中;貨況通知目前透過好運器 App 與 LINE 官方帳號送達。

集運 API 總覽:能讀哪些資料、怎麼申請

好運器集運 API 讓會員用自己的金鑰,從自己的系統讀取自己在好運器的帳單、包裹、預報與稅單。門檻只有一個:加「好運器集運官方帳號」LINE 好友;免人工審查,金鑰效期 1 年,每把金鑰每分鐘 60 次、每日 5,000 次。

三個入口怎麼選

入口適合誰認證方式能讀什麼次數上限
會員資料 API
https://0523.tw/api/v1/me
想讓自家系統、ERP、排程腳本讀自己資料的會員Bearer 金鑰(在 /member/api 自助建立)自己的帳單、包裹、預報、關稅稅單與進口報單每把金鑰每分鐘 60 次、每日 5,000 次
會員 MCP
https://0523.tw/mcp
想用 Claude、ChatGPT 等 AI 助理查自己包裹的會員OAuth 2.1 授權,不用複製金鑰和會員資料 API 相同,以 6 支唯讀工具提供預設每分鐘 60 次、每日 5,000 次
公開 MCP
https://0523.tw/mcp/public
任何人、任何支援 MCP 的客戶端免金鑰、免 OAuth運費與進口稅費試算、CCC 稅則與輸入規定、超材費、集運流程;不含任何會員資料每個 IP 每分鐘 120 次

集運 API 能讀哪些資料

全部端點都是唯讀的 GET,Base URL 為 https://0523.tw/api/v1/me,回應為 JSON。

列表端點可分頁(per_page 上限 100),時間為台北時區,金額一律新台幣。新會員還沒有任何資料時回 200 與空陣列,不會報錯。個資預設遮罩:身分證字號只露前 3 碼與後 3 碼、地址只保留縣市、電話遮中段;稅單與報單欄位採白名單輸出,不含 OCR 原始全文。

申請門檻與金鑰

速率限制

每把金鑰分開計算,同時有「每分鐘 60 次」與「每日 5,000 次」兩道限制。超過任一道會收到 HTTP 429,並附 Retry-After 標頭告訴你幾秒後再試;成功回應也會附上剩餘次數的標頭,方便自己節流。請不要用高頻輪詢逼近上限來模擬即時更新。

和 MCP 的關係

MCP(Model Context Protocol)是讓 AI 助理呼叫外部工具的標準介面。好運器的會員 MCP 讀的是和集運 API 相同的資料,差別在授權方式:API 用你自己保管的金鑰,會員 MCP 則在好運器頁面用 OAuth 授權,AI 助理拿不到你的密碼或金鑰,門檻與次數上限和 API 相同。只想讓 AI 算運費、稅金或查稅則,用免金鑰的公開 MCP 即可。

Webhook 目前規劃中。現在可以在 /member/api 設定並驗證 Webhook 網址,但會員事件(帳單、包裹狀態、放行、報單)尚未開始推送。上線前請以較低頻率定時查詢;包裹狀態通知目前透過好運器 App 與 LINE 官方帳號送達。
另外,運費、稅金、貨況查詢三份文件屬於「服務市場 API」,給合作平台串接,使用另一套服務市場金鑰,需另外申請,和上面的會員金鑰不通用。其中運費 API 採跨境電商合作專案費率、以人民幣計價;一般會員的新台幣運費請用運費+稅金試算或公開 MCP 的 lucky_freight_quote。

集運 API 常見問題

申請好運器集運 API 金鑰要審核嗎?

不需要人工審查。登入會員後到 /member/api,帳號須已連結 LINE 並加「好運器集運官方帳號」為好友,輸入應用名稱、同意開發者條款就能建立金鑰。每個帳號最多同時保有 5 把有效金鑰。

金鑰過期或遺失怎麼辦?

金鑰效期 1 年,到期不支援續期,要重新建立。金鑰明文只在建立當下顯示一次,遺失無法找回,請在 /member/api 撤銷舊金鑰後重建一把新的。

為什麼 API 回應 HTTP 429?

每把金鑰每分鐘 60 次、每日 5,000 次,超過任一道就回 429,並附 Retry-After 標頭告訴你幾秒後再試。成功回應的標頭也會附剩餘次數,請依此節流,不要用高頻輪詢逼近上限。

集運 API 和 MCP 有什麼不同?該用哪一個?

會員資料相同,差在使用方式:自家系統、ERP 或排程腳本用 API 金鑰直接呼叫 REST 端點;想用 Claude、ChatGPT 等 AI 助理以對話方式查包裹,就接會員 MCP,以 OAuth 授權、不必複製金鑰,接法見〈集運 MCP 教學〉。只想算運費與稅金,用免金鑰的公開 MCP 即可。

可以用 API 查別人的包裹,或幫客戶代查嗎?

不行。金鑰只能讀金鑰擁有者本人的資料,查不到或不屬於你的資料一律回 404。代理查詢、轉售存取權都違反開發者條款,好運器可逕行停權或撤銷金鑰。

包裹狀態一變,能用 Webhook 通知我的系統嗎?

會員事件的 Webhook 推送仍在規劃中。目前可以在 /member/api 設定並驗證網址,但系統還不會送出帳單、包裹狀態、放行等事件。上線前請以較低頻率定時查詢;包裹狀態通知目前透過好運器 App 與 LINE 官方帳號送達。

頁面更新日期