VTAP API Designer 入门 – 第 2 部分

之前,在我们的 Vtiger 应用平台 (VTAP) 博客系列中,我们讨论了如何自定义 Vtiger 界面并包含自定义按钮和小部件以满足特定的业务需求。这只是该平台提供的功能之一。

VTAP 为您提供了许多功能,可帮助您:

  • 创建自定义 REST API
  • 使用可用的 REST API 连接到其他应用程序
  • 连接到启用 OAuth 的应用程序

在这篇博客中,我将讨论如何创建自定义 REST API。

首先,让我稍微谈谈 Vtiger REST API。可以使用下面的端点进行访问,该端点特定于您的 CRM 实例。

如果您了解 Vti那么您可以跳过下面的部分。要了解可访问的模块,您可。

下面是如何使用 Postman 客户端访问 API 的屏幕截图。

 

Vtiger 已经提供了一组标准 API,

但借助新的 API 设计器工具,您现在可以编写自己的自定义 REST API。

API 设计器

API 设计器为开发人员提供了一个工作台,以开发基于 HTTP 的 API,这些 API 可以暴露给 Javascript VTAP API 或外部应  准确的手机号码列表 用程序,以便于集成。可以使规范来定义 API。
API 访问需要用户权限,并遵循 CRM 中实施的标准记录访问配置。
API 设计器提供了一个用于编写自定义 API 的 IDE。如果您为特定模块编写自定义 REST API,则需要命名 API 并选择模块。

我们基于 XML 语法定义了

Vtiger 应用程序 这里的潜在客户有 定义语言 (VADL),以允许管理员或新手开发人员无需编程专业知识即可定义 API。

  • 定义 CURD
    • 实体模块上的 API(创建、更新、检索、删除)
    • 通过方法 (GET/POST/PUT/DELETE) 调用基于 HTTP 的端点 (REST/SOAP)
      • 具有身份验证(基于基本/承载令牌)
    • 接受请求参数和链接作为 API 输入

让我们举一个例子,创建一个自定义 REST API,搜索与电子邮件域匹配的联系人。我们将添加一个名为“fetch_email_contact”的新 API,并选择联系人模块

 

所有定义都放在具有标准 HTTP 类型

 

(get、post、set 和 delete)的节点API内。由于我们从 CRM 获取数据,我们将使用选择按钮并传递模块名称。我们 萨法伊新闻 将在写入节点内获取需要获取的字段,并在Where节点内获取任何过滤条件。我们支持等于、不等于、类似、大类型 。上面是一个简单的示例,也可以使用RES实现:当您将多个 API 组合成一个时,真正的威力就会显现出来。

返回頂端