Server API reference
伺服器端 API 概覽
伺服器端 API 供可信後端管理應用程式使用者、簽發用戶端 token、傳送訊息、管理群組、上傳檔案、觸發推播並存取 AI 能力。
架構與進入點
伺服器端 API 是依應用程式隔離的 HTTP JSON 介面，使用部署的 api_endpoint，並透過控制台提供的 app_id 與 access-token 請求標頭驗證。
Reference 導覽
依目前工作選擇最精確的參考頁面。以下項目皆連至本站託管的自動產生 API 文件。
Users說明 Users 的完整 API、參數、回傳值、錯誤與回呼約定。Tokens說明 Tokens 的完整 API、參數、回傳值、錯誤與回呼約定。Rosters說明 Rosters 的完整 API、參數、回傳值、錯誤與回呼約定。Groups說明 Groups 的完整 API、參數、回傳值、錯誤與回呼約定。Messages說明 Messages 的完整 API、參數、回傳值、錯誤與回呼約定。Files說明 Files 的完整 API、參數、回傳值、錯誤與回呼約定。Push說明 Push 的完整 API、參數、回傳值、錯誤與回呼約定。AI說明 AI 的完整 API、參數、回傳值、錯誤與回呼約定。建議整合流程
- 從控制台取得 api_endpoint、app_id 與 access-token，並只把 access-token 儲存在後端機密管理中。
- 建立或對應應用程式使用者，再為對應用戶端 SDK 簽發使用者 token。
- 由後端呼叫資源介面，設定逾時、錯誤處理與必要的冪等策略。
- 僅執行已由自身業務權限模型授權的訊息與管理操作。
- 定期輪替機密，並分離正式、測試、專屬雲與私有雲端點設定。
使用時需要注意
- API 簽章與識別碼必須保持不變；AI 解說只補充整合語意。
- 先確認物件生命週期、執行緒與非同步回呼，再把結果同步到 UI。
- 若 AI 解說與目前 SDK 簽章衝突，應以簽章和實際版本為準。
繼續閱讀
Server API
環境與驗證
呼叫 API 前，從控制台取得 api_endpoint、app_id 與 access-token。請求標頭攜帶 app_id 與 access-token；預設 Content-Type 為 application/json。
託管 API 位址
http://s-1-3-api.maximtop.cn
以應用程式實際回傳的 api_endpoint 為準。專屬雲與私有部署使用各自的服務位址。
請求參數
| 欄位 | 說明 |
|---|---|
api_endpoint | 應用程式部署對應的 Base URL。 |
app_id | 透過請求標頭傳送的應用程式識別碼。 |
access-token | 透過請求標頭傳送的伺服器端憑證，不得暴露給用戶端。 |
Content-Type | 介面未特別說明時使用 application/json。 |
文件版本：v1.0