之前，在我們的 Vtiger 應用平台 (VTAP) 博客系列中，我們討論瞭如何自定義 Vtiger 界面並引入自定義按鈕和小部件以滿足特定的業務需求。 這只是該平台提供的一項功能。
VTAP 為您提供了許多此類功能，可幫助您：
- 創建自定義 REST API
- 連接到其他具有 REST API 可用的應用程序
- 連接到啟用 OAuth 的應用程序
在本博客中，我將討論如何創建自定義 REST API。
首先，讓我簡單介紹一下 Vtiger REST API。 可以通過以下端點進行訪問，該端點特定於您的 CRM 實例。
例如，https://your_instance.odx.vtiger.com/restapi/v1/vtiger/default
如果您知道 Vtiger Rest API，那麼您可以跳過以下部分。 要了解可訪問的模塊，您可以使用 列表類型 API。
以下是如何使用郵遞員客戶端訪問 API 的屏幕截圖。
Vtiger 已經提供了一組標準的 API，但是使用新的 API Designer 工具，您現在可以編寫自己的自定義 REST API。
API設計師
API Designer 為開發人員提供了一個工作台來開發基於 HTTP 的 API，這些 API 可以暴露給 VTAP Javascript API 或外部應用程序以便於集成。 API 可以使用定義 VADL 規格。
API 訪問需要用戶授權並遵循 CRM 中製定的標準記錄訪問配置。
API Designer 提供 IDE 來編寫自定義 API。 如果您為特定模塊編寫自定義 REST API，則需要命名該 API 並選擇該模塊。
我們定義了 Vtiger 應用程序定義語言 (VADL)，它基於 XML 語法，使新手管理員或開發人員無需編程專業知識即可定義 API。
VADL 允許您：
- 定義 CURD
- 實體模塊上的 API（創建、更新、檢索、刪除）
- 通過（GET/POST/PUT/DELETE）方法調用基於 HTTP（REST/SOAP）的端點
- 帶身份驗證（基於基本/不記名令牌）
- 接受請求參數並綁定為 API 輸入
讓我們舉一個創建自定義 REST API 的示例，該 API 將搜索與電子郵件域匹配的聯繫人。 我們將添加一個名為“fetch_email_contact”的新 API 並選擇聯繫人模塊
所有的定義都放在一個 API 具有標準 HTTP 類型（獲取、發布、放置和刪除）的節點。 由於我們從 CRM 獲取數據，因此我們將使用 選擇節點 並傳遞模塊名稱。 我們將有需要在內部獲取的字段 記錄節點 以及內部的任何過濾條件 哪裡 節點。 我們支持不同類型的 條件 像等於、不等於、像、大於、小於等。
上面是一個簡單的例子，也可以使用現有的 詢問 REST API。當您將多個 API 組合為一個時，真正的力量就變得顯而易見了。
考慮這個例子。 如果存在則更新記錄，如果不存在則創建記錄。 如果您使用現有 API，則需要多次調用才能執行這些操作。 但是當您使用 API Designer 時，您可以將這些操作組合到一個 API 調用中。
在上面的例子中，我們將定義放在 插入 節點。 這包括 更新 和 創建信息圖 節點，如果存在則更新記錄，如果不存在則創建記錄。 要識別需要更新的記錄，您可以使用 where 來過濾並查找相關條目。 定義結束時，返回節點將定義的字段發送回客戶端。
您可以保存和發布這些 API，使它們可用於外部應用程序和內部 VTAP Javascript。
訪問通過 API Designer 發布的自定義 API
- 要訪問通過 API Designer 發布的任何自定義 API，您需要使用以下端點。
- https://your_instance.odx.vtiger.com/restapi/vtap/api/API_NAME？參數
- API_NAME 應替換為給 API 的名稱。 此外，請確保您使用的是適當的 HTTP 類型和 證書（用戶名和訪問密鑰）來訪問它。
訪問最近創建的 獲取電子郵件聯繫方式 使用郵遞員的 API
- 訪問最近創建的 獲取電子郵件聯繫方式 API 使用郵遞員，你應該使用下面的。
- https://your_instance.odx.vtiger.com/restapi/vtap/api/fetch_email_contact?domain=%vtiger.com%
備註 ：https://your_instance.odx.vtiger.com/restapi/v1/ApiDesigner/api/fetch_email_contact?domain=%vtiger.com% 已棄用。
可以使用 VTAP Javascript API 在模塊設計器內部訪問這些 API VTAP.CustomApi.Get 顯示在 Vtiger 用戶界面中的小部件或自定義頁面內。
最後，我們了解了 API Designer 工具如何允許您編寫自定義 REST API 並在內部和其他應用程序中使用它們來無縫使用 CRM 數據。
如有任何其他疑問，請發送電子郵件至 [電子郵件保護]。 註冊開發者版本 点击這裡.
