文件/API 參考

安裝

整頁原始碼會落在 app/templates/docs-api-reference/。也可以改用長效授權金鑰：在 components.json 的 registries 設定 Authorization: Bearer <key>，適合 CI 或多人共用的專案。使用範圍見授權條款。

包含的區段

同一套模板內的區段共用設計 token，所以抽換、重排之後配色、間距與動畫節奏仍然一致。可在區段組裝器裡挑選組合。

1. 1

   頂欄與 API 概覽

   深色頂欄搭配 Relay API 概覽、系統狀態徽章與基礎網址、版本、驗證方式四張資訊卡。

   hero
2. 2

   驗證

   說明 Bearer 金鑰驗證方式，附 cURL 範例程式碼區塊與金鑰安全警告。

   content
3. 3

   快速開始

   三分鐘上手指南，含安裝 SDK 與送出第一則訊息的 TypeScript 範例。

   content
4. 4

   API 端點

   左側導覽樹搭配列出訊息、傳送訊息與建立頻道三個端點的參數表與請求回應範例。

   product
5. 5

   事件與簽章

   列出 Webhooks 事件清單並示範以 HMAC 驗證 Relay 簽章的實作。

   features
6. 6

   錯誤代碼

   標準 HTTP 錯誤代碼對照表與結構化 error 物件的回應範例。

   content
7. 7

   速率限制

   說明每分鐘請求上限、速率標頭意義與建議的退避重試策略。

   content
8. 8

   頁尾

   品牌標誌、產品資源支援三欄連結與 API 運行狀態的深色頁尾。

   footer