跳轉到主要內容
私人測試版。 新組織預設已啟用。組織管理員仍須在 Brightalk 設定中建立具權限範圍的 API 金鑰,請求才能通過驗證。可用範圍與限制以本文件和 OpenAPI 契約為準。
每個非 2xx 回應都使用一致的 JSON 格式。請依穩定的 error.code 分類錯誤,不要依賴供人閱讀的 message

錯誤回應格式

details 為選用且可供機器讀取的內容。客戶端應忽略 details 中的未知欄位。

請求關聯

每個回應都包含 X-Request-Id 標頭,錯誤內容也會在 error.request_id 重複同一值。請將該識別碼與失敗操作一起記錄,並在聯絡 Brightalk 支援時提供。不要記錄 API 金鑰或完整聯絡人資料。 您可以傳送 X-Request-Id,使用 1–64 個 A-Za-z0-9._:- 字元。若省略或傳送不合格式的值,Brightalk 會改用產生的識別碼。

驗證錯誤的差異

這些回應只描述憑證是否可用,不會洩漏其他組織的資源。

狀態與錯誤目錄

對已知路徑使用不支援的方法時,回應也包含 Allow。適合等待後重試的情況會包含 Retry-After。錯誤回應絕不揭露實作名稱、內部資料內容、查詢細節或堆疊追蹤。