摘要
API token 允許外部系統(例如客戶關係管理 (CRM) 平台或自訂應用程式)安全地與 Wati 連接並存取其 API。本指南說明如何在 Wati 中產生 API token、選擇正確的權限,以及如何安全地儲存 token 以供日後使用。
說明
請按照以下步驟在您的 Wati 帳戶中產生新的 API token。
步驟 1:登入您的 Wati 帳戶
登入您的 Wati 帳戶。
步驟 2:前往 API Tokens 頁面
前往 Connector > API Tokens。
步驟 3:產生新的 API token
在 API Tokens 頁面上,點擊 Generate new token。
輸入一個 token 名稱以便識別該 token。
步驟 4:選擇所需的權限 (scopes)
選擇您的整合所需的權限。這些權限稱為 scopes,定義了 token 被允許存取的範圍。
常用 scope 的範例包括:
contacts:read— 允許讀取聯絡人資料contacts:write— 允許建立或更新聯絡人messagetemplate:read— 允許讀取訊息範本資訊
為了提升安全性,請僅選擇您整合所需的 scope。
步驟 5:設定過期日期(選填)
您可以為 token 設定 過期日期。這有助於限制 token 的有效期限,進而降低安全風險。
為了獲得更好的安全性,建議 每 6 個月更換 (rotate) 一次 API token。
步驟 6:複製並安全地儲存 token
Token 產生後:
請立即複製 token。
將其安全地儲存在您的密碼管理器或安全環境中。
重要:該 token 僅在產生時顯示一次。如果您遺失了它,則需要重新產生一個新的 token。
注意事項:
Create New Token 選項移除了使用者層級的依賴關係,這意味著該 token 不依賴於特定的使用者帳戶。
Token 將保持有效,直到:
到達 過期日期,或
被 手動更新或撤銷。
所需的 API scopes: V3 API 端點需要對應的 V3 scopes。例如:
contactsv3:*、conversationsv3:*和messagetemplatev3:write。
Scope 要求: 每個端點均接受該端點所列出的其中任何一個 scope。請確保您的 API token 至少包含所需的 scope 之一。如果您的使用者角色或訂閱方案沒有所需的權限,也可能會發生
403 Forbidden錯誤。
Scope 命名: Wati API scopes 使用
wati_前綴。在設定或引用所需 scope 時,請包含此字首。
保持您的 API token 安全有助於保護您的整合,並防止他人未經授權存取您的 Wati 帳戶。
常見問題 (FAQs)
API token 基礎知識與權限
1. 什麼是 Wati 中的 API token?
API token 允許外部系統(例如客戶關係管理 (CRM) 平台或自訂應用程式)安全地與 Wati 連接並存取其 API。
2. Wati 中的 API token scopes 是什麼?
API token scopes 是定義整合可以存取哪些 Wati 資源和操作的權限。例如,scope 可以允許整合讀取聯絡人資料、建立或更新聯絡人,或是讀取訊息範本資訊。
3. Wati V3 API 端點需要哪些 API scopes?
Wati V3 API 端點需要對應的 V3 scopes。範例包括 contactsv3:*、conversationsv3:* 和 messagetemplatev3:write。每個 API 端點均接受該端點列出為「必需」的其中任何一個 scope。您的 API token 必須包含至少一個所需的 scope。
4. 為什麼我在使用 Wati API token 時會收到 403 Forbidden 錯誤?
如果您使用的 API token 沒有包含該 API 端點所需的至少一個 scope,可能會出現 403 Forbidden 錯誤。此外,若您的使用者角色或訂閱方案沒有所需的權限,也可能導致此錯誤。
API token 過期與安全性
5. Wati API token 會自動過期嗎?
Wati API token 會一直保持有效,直到到達其設定的過期日期,或是被手動更新或撤銷。設定過期日期是選填項目,有助於限制 token 的有效期。
6. 我可以在產生後重新找回我的 Wati API token 嗎?
不行。Wati 僅在產生 API token 時顯示一次。請在產生時務必複製並安全儲存該 token。如果您遺失了 token,則必須重新產生一個新的。為了獲得更好的安全性,Wati 建議每 6 個月更換一次 API token。
Did this answer your question?