應用程式與API

你可以使用CINNOX Open API，發送Requests和接收Response，從而運用CINNOX的功能和數據。以下列表列出Reports、Operations和Management，三種可供開發者使用的Open API類型。

有關詳細說明，可瀏覽API Reference。

 

Reports

 

Operations

 

Management

 

使用Open API前之注意事項

你的服務方案需為Omnichannel Contact Centre或以上級別，方可使用CINNOX Open API。詳細資料，請參考定價頁。

你必須在CINNOX控制面板，建立App ID，方可使用CINNOX Open API。此外，亦需使用App ID 、App Token和Base URL，作授權之用。

 

新增APP

如要在CINNOX控制面板新增APP：

• 身為CINNOX管理員，登入CINNOX控制面板。
• 導航到管理>服務整合>API>應用程式列表
• 點擊新增App。

• 在設置API平台，輸入App名稱。App名稱可以為任何名稱，但上限為50個字元。

• 點擊儲存。

• 點擊了儲存後，API憑證成功建立。API憑證包括以下三部份：
  • App ID
  • App Token
  • Base URL

 

重新產生App Token

保安原因，你可以重新產生App Token。

• 身為CINNOX管理員的你，登入CINNOX控制面板。
• 導航到管理>服務整合>API>應用程式列表
• 在你需要重新產生App Token的應用程式，點擊更多(...)。
• 點擊查看。

• 點擊重新產生按鈕。
• 點擊儲存。

 

編輯App名稱

如有需要，你可以編輯App名稱，務求與你團隊定下的命名方式一致。

• 身為CINNOX管理員的你，登入CINNOX控制面板。
• 導航到管理>服務整合>API>應用程式列表
• 在你需要重新產生App Token的應用程式，點擊更多(...)。
• 點擊查看。

• 輸入新的App名稱。

• 點擊儲存。

 

刪除App

你可以刪除不再使用的App。

• 身為CINNOX管理員的你，登入CINNOX控制面板。
• 導航到管理>服務整合>API>應用程式列表
• 在你需要重新產生App Token的應用程式，點擊更多(...)。
• 點擊刪除。

 

重要事項

📘

• 成功新增了App後，系統會為此自動產生App ID、App Token以及Base URL。
• 新增App的上限為10個。
• 編輯App名稱後，App ID、App Token以及Base URL保持不變。
• 刪除App同時亦會刪除其App ID和App Token。因此，當使用此App ID和App Token時，API Endpoint會發生錯誤。

 

CINNOX API Reference

關於CINNOX API的資料，請參考API Reference。

 

API日誌

你可以跟據以下步驟查看API日誌。

• 導航到管理>服務整合>API>API日誌分頁。
• API日誌會根據日期，顯示開發者在CINNOX進行的API活動，以及其涉及的數據。
• API日誌會顯示日期、方法、標題、狀態、IP位址、App ID和App Token資料。
• 管理員可以實時在API日誌查看API活動資料。你可以用App ID和日期範圍過濾所需資料。

 

協助和支援

請確定你是否使用正確的Base URL，以及已經新增了App。導航到管理>服務整合>API，使用正確的App ID和App Token。如需要支援，請電郵至[email protected]，聯絡CINNOX的技術支援團隊。