串接你的應用程式

把你的應用程式接上 BCS API。

把應用程式接上 BCS API 只需幾個步驟。

1

取得 base URL 與 API key

向客戶經理取得正式 base URL，向管理員取得一把 API key。

2

在每個請求帶上 key

於 HTTP header 加入 X-API-Key: ak_live_…。建議將 key 存於環境變數或密鑰管理服務。

3

解析統一信封

成功讀 data／meta，失敗讀 error.code。以 code 做程式判斷，message 僅供顯示。

4

處理計費與限流

讀 X-Credit-Remaining 掌握餘額；對 429 遵守 Retry-After，對 5xx 採退避重試。

5

設定即時通知（選用）

需要鏈上事件即時通知時，建立 Webhook 訂閱或使用 WebSocket 串流。

小提醒

• 自帶 X-Request-Id 可串接你自己的追蹤系統；不帶則由系統產生。

• 將不同用途的整合各用一把 key，方便個別控管與撤銷。

遇到問題？見請求失敗怎麼辦。