API代表應用程序編程接口。 在討論 API 時，任何具有特定功能的軟件都稱為應用程序。 您可以將 API 接口比作指定請求和響應的兩個程序之間的服務協議。 如果您不熟悉 API，我們建議您查看我們的 API 初學者指南 和 REST API 概述 在閱讀這篇博客之前。
REST API 允許您通過 HTTP/HTTPS 協議訪問 CRM 數據。 您可以對任何 CRM 記錄信息執行創建、更新、檢索或刪除操作等操作。 它還將允許您存儲特定於擴展和特定於用戶的配置數據，或使用存儲的特定於擴展的數據連接到外部應用程序。 所有這些數據都可以使用基本授權訪問，即通過用戶名和訪問密鑰。
創建 REST API
以下是可用於構建任何 API 的五個一般步驟：
- 規劃 API：API 規範（如 OpenAPI）提供了設計 API 的指南。 最好事先考慮各種用例，並確保 API 符合當前的 API 開發標準。
- 構建 API：API 設計者在對現有 API 進行少量修改的情況下創建新 API 的原型。 開發人員可以在原型經過測試後使其適應內部需求。
- 測試 API: 與軟件測試類似，API 測試是防止錯誤和缺陷所必需的。 使用 API 測試工具測試 API 抵禦在線攻擊的強度。
- 記錄 API：雖然 API 是不言自明的，但文檔可以更輕鬆地幫助用戶。 在面向服務的架構中，更頻繁地使用具有各種功能和用例的文檔齊全的 API。 編寫幫助文檔來指導並幫助其他人構建他們的 API。
- 市場API：有一些在線市場，開發人員可以在其中買賣 API，就像 eBay、Amazon 和 Flipkart 上的零售商品一樣。 您可以通過列出 API 從您的 API 中賺錢。
此博客將教您如何使用 Vtiger 的 API 設計器構建自定義 REST API 命令。 讓我們開始吧。
什麼是 API 設計師？
API Designer 是一個工具或應用程序開發人員可以用來構建自定義 Web 服務 API。 您可以定義自定義服務端點和查詢參數。 這些 API 可用於與 CRM 數據交互，與外部應用程序集成，並將這些數據公開給 VTAP Javascript API，以便在 Vtiger UI 的自定義頁面或小部件中使用。
您可以使用 Vtiger 應用程序設計語言創建 API（VADL)，它大致基於 XML 語法。 VADL 使沒有高級編程技能的管理員或開發人員可以輕鬆定義 API，但只要對編程有基本的了解，您就可以快速創建有效的 API。
REST API 遵循標準 REST API 協議，您可以按如下方式定義它們的端點：
| https://instance.odx.vtiger.com/restapi/vtap/api/YOUR_CUSTOM_API_PATH |
|---|
對於 REST API，支持以下 HTTP 請求方法：
- GET
- 解決方案&帖子
- PUT
- DELETE
讓我們看看如何使用 VTAP 構建自定義 REST API。
Vtiger CRM 用戶可以構建將 CRM 連接到其他第三方應用程序的 REST API，或者構建將擴展 CRM 功能的新應用程序。 這是一個例子：
讓我們創建一個 REST API，它可以 從訪問數據 具體的 模 使用 VTAP。
下面是一個例子 檢索數據的 API 來自名為 組織 以 API 名稱顯示年收入最高的前五個組織 頂級組織. 您可以使用不同的名稱以保持其獨特性。
在我們開始之前，讓我們了解將用於定義上述 API 示例的操作的 XML 和 VDAL 組件。
下表描述了將用於定義自定義 REST API 以訪問和顯示 CRM 數據的 XML 和 VDAL 組件：
| XML 和 VDAL 組件 | 行動 |
|---|---|
| api方法=“獲取” | 定義 HTTP 請求方法 |
| 選擇模塊=“賬戶” | 定義模塊以從使用中檢索數據 選擇 |
| 記錄 字段名=”賬戶名”> | 定義記錄中的字段以從使用中檢索數據 記錄 |
| 分類 field name=”annual_revenue” order=”descending” /字段 /種類 |
使用定義表結果的條件 分類 |
| 限制 max=”5″ page=”@page” /limit | 定義要顯示的記錄詳細信息的數量 限制 |
| /選擇 /API |
以關閉所有打開的標籤結束 |
備註 上表中的所有 XML 和 VDAL 組件都要用標籤 (<>) 括起來。
按照以下步驟構建上面討論的 REST API：
- 登錄到您的 Vtiger CRM 帳戶。
- 點擊 主頁.
- 點擊 平台.
- 選擇 API設計師.
- 點擊 +添加API.
- 點擊 創建 在 REST API 旁邊。 添加 REST API 窗口打開。
- 添加 REST API：輸入或選擇以下信息：
- 模塊：選擇必須從中訪問數據的 CRM 模塊。
- 姓名：輸入 API 的唯一標識符。
- Status：單擊複選框以激活 API。
- 點擊 節省.
- 添加 API 後，您將看到一個內置的 IDE，您將在其中使用 VADL 定義 API 和 XML 節點以檢索 CRM 數據。 請參閱上表以了解 XML 和 VADL 組件。
- 點擊 保存並發布 發布構建的 API。
您可以使用以下 URL 從任何外部應用程序訪問和測試上述 REST API。
| https://instance.odx.vtiger.com/restapi/vtap/api/top_organizations |
|---|
備註 上面的 URL 是一個示例，您必鬚根據您的 CRM 實例定義端點。
你知道嗎？
上述數據可用於在自定義頁面上顯示為列表，或用於條形圖和其他使用 javascript 組件定義 API 的動態結果。 API Designer 中內置的所有自定義 REST API 也可以使用 VTAP Javascript API.
要了解有關構建自定義 API 和 VTAP 的更多信息，請查看 VTAP 文檔.
