e02c24bd3a
Created by Github action --------- Co-authored-by: Abdul Rahman <ar5438376@gmail.com> Co-authored-by: Crowdin Bot <support+bot@crowdin.com> Co-authored-by: github-actions <github-actions@twenty.com> Co-authored-by: Charles Bochet <charles@twenty.com>
86 lines
3.0 KiB
Plaintext
86 lines
3.0 KiB
Plaintext
---
|
|
title: API 和 Webhooks
|
|
info: "創建和管理 API 金鑰以進行身份驗證，並設置 webhook 以獲取即時通知。"
|
|
image: /images/user-guide/api/api.png
|
|
sectionInfo: 學習如何將 Twenty 連接到您的其他工具。
|
|
---
|
|
|
|
import { VimeoEmbed } from '/snippets/vimeo-embed.mdx';
|
|
|
|
<Frame>
|
|
<img src="/images/user-guide/api/api.png" alt="Header" />
|
|
</Frame>
|
|
|
|
## API 密鑰
|
|
|
|
API 金鑰允許自動訪問您的 CRM 數據，將數據與其他系統同步，並創建自定義集成或解決方案。
|
|
|
|
### Create an API Key
|
|
|
|
1. Go to **Settings → APIs & Webhooks**
|
|
2. Click **+ Create key** at the top right
|
|
3. 配置您的 API 金鑰：
|
|
- **名稱**：為您的 API 金鑰賦予描述性名稱
|
|
- **過期日期**：設定金鑰的過期時間
|
|
4. 點擊 **保存** 以生成您的 API 金鑰
|
|
5. **重要**：立即複製並保存您的 API 金鑰，它僅顯示一次
|
|
|
|
創建後，您的 API 金鑰提供對您定制 API 文檔和測試平臺的訪問，您可以在此處使用實際數據模型測試端點。
|
|
|
|
<Warning>
|
|
|
|
由於你的 API 金鑰提供對敏感信息的訪問，不應與你無法完全信任的服務分享。 如果洩露，有人可能會惡意使用它。 如果您的 API 金鑰安全性受損，立即禁用它並生成新的金鑰。
|
|
如果洩露，有人可能會惡意使用它。 如果您的 API 金鑰安全性受損，立即禁用它並生成新的金鑰。
|
|
</Warning>
|
|
<VimeoEmbed videoId="928786722" title="Creating API key" />
|
|
|
|
### 管理 API 金鑰
|
|
|
|
**重新生成 API 金鑰：**
|
|
|
|
1. Go to **Settings → APIs & Webhooks**
|
|
2. 點擊要重新生成的 API 金鑰
|
|
3. 點擊**重新生成**按鈕
|
|
4. 立即複製並儲存新的 API 密鑰
|
|
|
|
**刪除 API 密鑰:**
|
|
|
|
1. 在列表中找到您的 API 密鑰
|
|
2. 點擊密鑰以打開其詳細信息
|
|
3. 點擊**刪除**以永久移除它
|
|
|
|
## Webhooks
|
|
|
|
Webhook 允許即時更新指定的 URL，以便了解有關您的客戶數據的變化或事件。
|
|
|
|
例如，當商機移至 "成功結束" 時，Webhooks 可以自動觸發會計系統中的發票創建。 請注意，這種類型的自動化也可以使用 Twenty 的應用內[工作流功能](/l/zh/user-guide/workflows/getting-started-workflows)實現，該功能提供基於欄位更新的內部自動化觸發器。
|
|
|
|
Webhooks 非常適合與外部系統集成，而工作流支持內部自動化和通過 webhook 觸發器、代碼節點和 HTTP 節點連接到外部工具。
|
|
|
|
### 創建 Webhook
|
|
|
|
1. Go to **Settings → APIs & Webhooks → Webhooks**
|
|
2. 點擊\*\*+創建 Webhook\*\*
|
|
3. 輸入您的 Webhook URL（您希望接收通知的位置）
|
|
4. 點擊**保存**
|
|
|
|
您的 Webhook 將立即開始接收有關 CRM 數據變更的實時通知。
|
|
|
|
<VimeoEmbed videoId="928786708" title="Video demonstration" />
|
|
|
|
### 管理 Webhooks
|
|
|
|
**刪除 Webhook:**
|
|
|
|
1. Go to **Settings → APIs & Webhooks → Webhooks**
|
|
2. 找到您要刪除的 Webhook
|
|
3. 點擊 Webhook
|
|
4. 點擊**刪除**並在彈出窗口中確認
|
|
|
|
**編輯 Webhook:**
|
|
|
|
1. 點擊您要修改的 Webhook
|
|
2. 更新 URL 或其他設置
|
|
3. 點擊**保存**以應用更改
|
|
|