從零到第一次成功呼叫的步驟清單。
依序完成下列項目,即可開始使用 BCS API。
取得 base URL — 向你的客戶經理確認正式服務網址(本文件以 https://api.blockchainsecurity.asia 示意)。
https://api.blockchainsecurity.asia
取得 API key — 請你方管理員在管理後台建立一把 key,並保存一次性回傳的明碼(ak_live_…)。
ak_live_…
確認連線 — 呼叫 GET /healthz,應回 {"status":"ok"}。
GET /healthz
{"status":"ok"}
發出第一個已認證請求 — 在 X-API-Key header 帶上 key,呼叫任一 /v1 端點。
X-API-Key
/v1
確認回應格式 — 成功回應為 { data, meta };記下回應 header 的 X-Request-Id。
{ data, meta }
X-Request-Id
掌握餘額 — 從 X-Credit-Remaining 追蹤 credit 餘額。
X-Credit-Remaining
設定錯誤處理 — 依錯誤碼與 Retry-After 實作重試(見請求失敗怎麼辦)。
Retry-After
完成以上步驟後,建議接著閱讀開發者文件了解各端點細節。
Last updated 1 month ago
Was this helpful?