📜  ZOHO API 按 ID 获取记录 (1)

📅  最后修改于: 2023-12-03 15:06:07.640000             🧑  作者: Mango

ZOHO API 按 ID 获取记录

ZOHO API 是针对 ZOHO CRM 平台的一组 API,可以让开发者通过编程的方式与 ZOHO CRM 进行交互。本文主要介绍如何使用 ZOHO API 按 ID 获取记录的方法。

前提条件

首先,你需要在 ZOHO CRM 平台上创建一个账号,并且创建了一个应用程序,然后获取到该应用程序的 Client ID 和 Client Secret。此外,你还需要获取到一个有效的 Access Token 才能调用 ZOHO API。

API Endpoint

按 ID 获取记录的 API Endpoint 的格式如下:

https://www.zohoapis.com/crm/v2/{module_api_name}/{record_id}

其中,{module_api_name} 是指要获取的记录所在的模块的 API 名称,例如联系人模块的 API 名称为 Contacts{record_id} 是指要获取的记录的 ID。

请求参数

请求头部需要携带 Access Token,格式如下:

Authorization: Zoho-oauthtoken ACCESS_TOKEN
返回值

该 API 调用成功后将会返回指定 ID 的记录的详细信息。

返回值示例:

{
    "data": [
        {
            "id": "1234567890123456789",
            "Owner": {
                "id": "1234567890123456789",
                "name": "John Doe"
            },
            "Company": {
                "id": "1234567890123456789",
                "name": "ABC Company"
            },
            "Last_Name": "Doe",
            "First_Name": "John",
            "Email": "johndoe@abccompany.com",
            "Phone": "123-456-7890",
            "Mobile": "098-765-4321"
        }
    ]
}
示例代码

以下是使用 Python 3.x 实现该 API 的示例代码:

import requests

# 替换为你的 Client ID 和 Client Secret
client_id = 'YOUR_CLIENT_ID'
client_secret = 'YOUR_CLIENT_SECRET'

# 替换为你的 Access Token
access_token = 'YOUR_ACCESS_TOKEN'

# 替换为要获取的记录所在的模块的 API 名称和 ID
module_api_name = 'Contacts'
record_id = '1234567890123456789'

# 构造 API Endpoint
base_url = 'https://www.zohoapis.com/crm/v2'
api_endpoint = f'{base_url}/{module_api_name}/{record_id}'

# 构造请求头部
headers = {
    'Authorization': f'Zoho-oauthtoken {access_token}'
}

# 发送请求
response = requests.get(api_endpoint, headers=headers)

# 解析响应
if response.status_code == 200:
    data = response.json()['data'][0]
    print(data)
else:
    print(response.status_code)

以上是使用 ZOHO API 按 ID 获取记录的方法的详细介绍。如果你想要了解更多 ZOHO API 的用法,请参阅 ZOHO CRM API 文档