📅  最后修改于: 2023-12-03 15:21:23.576000             🧑  作者: Mango
ZOHO API 是一套强大的 REST API 接口,可以轻松访问 ZOHO 套件中的各种应用程序数据。其中包括标准搜索 API,它允许开发者从 ZOHO 应用程序中获取数据,而无需编写自定义查询。下面是一份简要的指南,介绍如何使用 ZOHO API 标准搜索。
在使用 ZOHO API 标准搜索前,您需要注册 ZOHO 开发者帐户并获取 API Key。以下是一些简单的步骤:
创建 ZOHO 开发者账号。
创建一个新的 API 令牌。
访问 ZOHO CRM 或其他 ZOHO 应用程序的开发者控制台,创建一个新的 API Key,并将其与所需的应用程序关联。
ZOHO API 标准搜索使用一个简单的 HTTP GET 请求,通过将查询参数作为 URL 参数来获取数据。以下是一个示例请求:
GET https://crm.zoho.com/crm/private/json/Leads/searchRecords?authtoken=YOUR_AUTH_TOKEN&scope=crmapi&selectColumns=All&fromIndex=1&toIndex=200&searchCondition=(Last_Name:starts_with:Johnson)
其中包含以下参数:
authtoken
: 您的 API Key。
scope
: 应用程序范围。在此示例中,我们使用 crmapi
。
selectColumns
: 要返回的字段。使用 All
可获取所有字段。
fromIndex
和 toIndex
: 搜索结果的索引范围。
searchCondition
: 搜索条件。
对于搜索条件,可以使用各种条件表达式进行搜索。这包括等于(:
)、大于(>
)、小于(<
)、包含($
)、以......开始(starts_with:
)和以......结束(ends_with:
)等。以下是一些示例:
(Last_Name:equals:Johnson)
: 查找最后一个名称等于“ Johnson”的潜在客户。
(Annual_Revenue:$300)
:查找年收入为 300 美元的潜在客户。
(Created_Time:>2)
:查找创建时间超过 2 天的潜在客户。
ZOHO API 标准搜索返回的格式是 JSON。以下是一份示例响应:
{
"response": {
"result": {
"Leads": {
"row": [
{
"no": 1,
"FL": [
{
"content": "John",
"val": "First_Name"
},
{
"content": "Smith",
"val": "Last_Name"
},
{
"content": "jsmith@xyz.com",
"val": "Email"
}
]
},
{
"no": 2,
"FL": [
{
"content": "Jane",
"val": "First_Name"
},
{
"content": "Doe",
"val": "Last_Name"
},
{
"content": "jdoe@xyz.com",
"val": "Email"
}
]
}
]
}
},
"uri": "/crm/private/json/Leads/searchRecords",
"header": {
"result": "Success",
"message": "No Records Found"
}
}
}
在上面的响应中,我们可以看到包含搜素结果的 FL(字段)数组。您可以根据需要获取更多或少的字段。
ZOHO API 标准搜索是一个非常有用的 API,允许开发人员轻松地从 ZOHO 应用程序中检索数据,而无需编写自定义查询。本指南提供了一些基本的示例,以帮助您入门。现在您可以开始尝试使用该 API,以轻松检索 ZOHO 内的数据!