
如何快速實現REST API集成以優化業務流程
1.應用–新建應用
2.第一次注冊需要先實名認證實名認證
3.實名認證成功以后新建應用
1.點擊剛剛創建的應用
2.進入機器人頁面點擊機器人菜單然后復制Token
在開發者中心,在創建機器人后,我們可以得到一個 token,在請求所有的 KOOK 接口時,我們需要在 http header 的 Authorization
中加入該 token 以進行鑒權,格式為 Authorization: TOKEN_TYPE TOKEN
。目前支持兩種格式的鑒權:
如下為機器人的鑒權示例:
Authorization: Bot BHsTZ4232tLatgV5AFyjoqZGAHHmpl9mTxYQ/u4/80=
地址 | 請求方式 | 說明 |
---|---|---|
/api/v3/guild/list | GET |
參數名 | 位置 | 類型 | 必需 | 說明 |
---|---|---|---|---|
page | query | integer | false | 目標頁數 |
page_size | query | integer | false | 每頁數據數量 |
sort | query | string | false | 代表排序的字段, 比如-id 代表 id 按 DESC 排序,id 代表 id 按 ASC 排序。不一定有, 如果有,接口中會聲明支持的排序字段。 |
參數名 | 類型 | 說明 |
---|---|---|
id | string | 服務器 id |
name | string | 服務器名稱 |
topic | string | 服務器主題 |
user_id | string | 服務器主的 id |
icon | string | 服務器 icon 的地址 |
notify_type | int | 通知類型, 0 代表默認使用服務器通知設置,1 代表接收所有通知, 2 代表僅@被提及,3 代表不接收通知 |
region | string | 服務器默認使用語音區域 |
enable_open | boolean | 是否為公開服務器 |
open_id | string | 公開服務器 id |
default_channel_id | string | 默認頻道 id |
welcome_channel_id | string | 歡迎頻道 id |
boost_num | integer | 服務器助力數量 |
level | integer | 服務器等級 |
屬性 | 屬性值 |
---|---|
notify_type | 0 |
notify_type | 1 |
notify_type | 2 |
notify_type | 3 |
{
"code": 0,
"message": "操作成功",
"data": {
"items": [
{
"id": "91686000000",
"name": "Hello",
"topic": "string",
"user_id": "2418200000",
"icon": "https://xxx/icons/2020-05/YQyfHxxx.png/icon",
"notify_type": 0,
"region": "beijing",
"enable_open": true,
"open_id": "012312413",
"default_channel_id": "5915900001396830",
"welcome_channel_id": "5789900001312330",
"boost_num": 3,
"level": 0
}
],
"meta": {
"page": 1,
"page_total": 10,
"page_size": 50,
"total": 480
},
"sort": {
"id": 1
}
}
}
Q:如何找到KOOK API
A:冪簡集成是國內領先的API集成管理平臺,專注于為開發者提供全面、高效、易用的API集成解決方案。冪簡API平臺可以通過以下兩種方式找到所需API:通過關鍵詞搜索API(例如,輸入’KOOK API‘這類品類詞,更容易找到結果)、或者從API hub分類頁進入尋找。
Q:速度限制?
A:為了保護我們的系統,我們在?RFC 6585?的基礎上做了一些擴展,來限制用戶的接口調用速度。經常達到限速閥值或者忽略速度限制的 API 用戶將會被撤銷 API 密鑰,并且被限制登錄。有關速度限制的問題,請參閱速率限制一節
Q:Gateway?
A:Gateway 是 websocket 的網關,客戶端通過連接 Gateway 可以獲取到相應的推送消息等。
Q:消息壓縮?
A:
compress
參數為 1
, 所有方向為 server->client
的消息都是經過壓縮后的binary
類型的消息.compress=0
。Q:超速響應?
A:當觸犯速度限制時,系統會返回 http 429 響應。返回的消息格式與標準格式也是一致的。同時,上文中提到的 http 頭也依舊會傳。
Q:封禁措施?
A:如果多次超速,系統會發出警告信息。bot 需要按照 rate limit 的頭進行速度控制。
如果多次警告后依然不更改,系統可能會禁用 bot。
除了KOOK API,還有其他替代服務商也提供類似api服務,例如:
Hoiio API開放平臺、Dialpad API開放平臺、livestorm API開放平臺
更多競品可以在冪簡集成開放平臺中找到。
Q:KOOK API這個密鑰還適用于哪些api?
獲取當前用戶加入的服務器列表、服務器靜音閉麥列表、頻道角色權限詳情
本文全面且細致地介紹了如何獲取KOOK API開放平臺訪問token的分步指南,為開發者們提供了一份條理清晰、操作簡便的實用手冊。從KOOK API平臺的賬號注冊,到完成開發者身份認證,再到最終成功獲取訪問token,每一步操作都配以詳盡的說明與指導,確保開發者能夠輕松、準確地完成整個流程。獲取訪問token只是利用KOOK API的第一步,如何高效、穩定地集成并應用這些強大的功能接口才是關鍵。因此,在本文中,我們不僅指導了如何獲取訪問token,還強調了獲取后進行初步測試與驗證的重要性。通過測試,開發者可以確保KOOK API能夠順利集成到應用中,并發揮出最佳效果,從而提升應用的性能和用戶體驗。本文為開發者們提供了一個全面、詳盡且極具實用性的操作指南,幫助他們順利獲取KOOK API開放平臺的訪問token,并將這一強大的功能接口高效地集成到應用中。我們相信,隨著開發者們對這一指南的深入理解和實踐,將能夠在即時通訊、團隊協作等領域取得更加顯著的成果,為用戶提供更加便捷和高效的應用體驗。