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
删除

让我们看看如何使用 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	以关闭所有打开的标签结束