快速開始
你需要先在 IMKIT Dashboard 建立一組帳號,並且建立一個 Chat Server (Application) 以獲得 Client Key 與 API Key 來使用 IMKIT Platform API。
步驟一:建立帳戶
- 前往 IMKIT Dashboard 的註冊畫面,依照指示完成帳號註冊。除了 Email 外,也可用 Apple ID 進行註冊。

- 完成帳號註冊後,請至註冊的信箱收取驗證信,同樣依照指示完成驗證。

步驟二:建立 Chat Server
- 點擊下方
Add Application

- 輸入 Application 的名稱(可以是您的網站或 App 的名稱)

- 選擇對應的 SDK 環境

- 點擊
Complete完成 Chat Server 建立

步驟三:獲得 Chat Server 相關 Key 值與參數
- Client Key:由 SDK 端呼叫後端 API 時使用的 Key,於 API 文件中會標示為
IM-CLIENT-KEY

- Backend API Key:由 Admin 呼叫後端 API 時使用的 Key,權限最高,於 API 文件中會標示為
IM-API-KEY

- Chat Server URL:此 Application 的 Chat Server 實際網址,網址會是
https://[YourApplicationName].imkit.io

步驟四:使用 Postman 測試 API(選用)
取得 Key 值後,可以匯入我們提供的 Postman Collection,立即對 Chat Server 進行 API 測試,無需撰寫任何程式碼。
下載
匯入步驟
- 開啟 Postman,點擊左上角 Import,分別匯入上方兩個 JSON 檔案
- 切換至右上角的 Environment 選單,選擇 IMKit API,點擊 Edit 填入以下變數:
| 變數 | 對應值(來自步驟三) |
|---|---|
domain | Chat Server URL(如 https://myapp.imkit.io) |
apiKey | Backend API Key |
clientKey | Client Key |
token | 呼叫「Create or Update User」後取得的 Access Token |
- 儲存後即可選擇任一 request 點擊 Send 開始測試