导入
获取人员详情
学习并练习如何使用 Clearbit 的人员 API 获取人员的基本信息。
如果消费者对我们公司提供的服务感兴趣,我们可能会迎来新的注册用户。然而,只有经过身份验证的用户注册才有价值,虚假注册则无意义。我们如何判断这一点?一种方法是花费大量时间调查用户,另一种更高效的方法是使用 Clearbit 的增强 API。该 API 提供三个接口:
- 人员接口(Person API)
- 公司接口(Company API)
- 综合接口(Combined API)
接口说明
人员接口(Person API)
请求地址:
1https://person.clearbit.com/v2/people/find?email={email_of_person}
| 字段 | 类型 | 必填 | 描述 |
|---|---|---|---|
| string | 必填 | 用于查找人员信息的邮箱地址。 | |
| given_name | string | 可选 | 人员的名。 |
| family_name | string | 可选 | 人员的姓。提供此参数可提高匹配准确率和结果可靠性。 |
| ip_address | string | 可选 | 目标人员的 IP 地址。提供此参数可提高匹配准确率和结果可靠性。 |
| location | string | 可选 | 人员所在的城市或国家。 |
| company | string | 可选 | 人员所属雇主名称(通常是公司名),例如 Google。 |
| company_domain | string | 可选 | 人员所属雇主的域名,例如 google.com。 |
| string | 可选 | 人员的 LinkedIn 个人主页链接。 | |
| string | 可选 | 人员的 Twitter 账号。 | |
| string | 可选 | 人员的 Facebook 个人主页链接。 | |
| webhook_url | string | 可选 | 用于接收可能延迟的结果的 Webhook 地址。 |
| webhook_id | string | 可选 | Webhook 请求的自定义标识符。 |
| subscribe | boolean | 可选 | 设置为 True 时,可接收人员信息的任何更新通知。 |
| suppression | string | 可选 | 用于排除特定国家的数据。例如设置为 us 会排除美国的数据;设置为 us_strict 会排除美国数据或无国家信息的数据。 |
示例邮箱地址
JavaScript 代码示例
1import fetch from 'node-fetch'; 2 3const API_KEY = 'Bearer {{API_KEY}}'; 4 5const endpointUrl = new URL('https://person.clearbit.com/v2/people/find'); 6 7const headerParameters = { 8 authorization: API_KEY, 9 contentType: 'application/json', 10}; 11 12const queryParameters = new URLSearchParams({ 13 email: '{{EMAIL}}' 14}); 15 16const options = { 17 method: 'GET', 18 headers: headerParameters, 19}; 20 21async function fetchData() { 22 try { 23 endpointUrl.search = queryParameters; 24 const response = await fetch(endpointUrl, options); 25 26 // 自定义函数:打印 API 响应 27 printResponse(response); 28 } catch (error) { 29 // 自定义函数:打印错误信息 30 printError(error); 31 } 32} 33 34// 调用函数发起 API 请求 35fetchData();
返回字段说明
| 字段 | 类型 | 描述 |
|---|---|---|
| id | string | Clearbit 内部关联该人员的唯一 ID。 |
| name | object | 包含人员姓名信息的对象,包括名、姓及其他相关名称。 |
| location | string | Clearbit 能获取到的最准确的人员所在地。 |
| geo | object | 包含人员地理信息的对象,如纬度、经度、城市、州、街道编号等。 |
| bio | string | Clearbit 能获取到的最准确的人员简介。 |
| site | string | 人员的个人网站(如有)。 |
| avatar | string | Clearbit 能获取到的最佳头像图片 URL。 |
| employment | object | 包含人员就业信息的对象。 |
修正不准确信息
Clearbit 的人员查询采用模糊匹配,因此可能存在不准确的结果。为了帮助 Clearbit 改进数据质量,你可以使用其 标记人员 接口,将错误信息标记为不正确,并提交正确的属性值,以便他们进行修正。该操作通过 POST 方法完成。
标记人员接口地址:
1https://person.clearbit.com/v1/people/{id_of_person}/flag
| 字段 | 类型 | 可选 | 描述 |
|---|---|---|---|
| given_name | string | 可选 | 人员的名。 |
| family_name | string | 可选 | 人员的姓。 |
| employment_title | string | 可选 | 人员在公司的职位名称。 |
| facebook_handle | string | 可选 | 人员的 Facebook ID 或用户名。 |
| github_handle | string | 可选 | 人员的 GitHub 用户名。 |
| twitter_handle | string | 可选 | 人员在 Twitter 上的用户名。 |
| linkedin_handle | string | 可选 | 人员的 LinkedIn 链接。 |
| googleplus_handle | string | 可选 | 人员的 Google+ 用户名。 |
标记人员代码示例
1import fetch from 'node-fetch'; 2 3const API_KEY = 'Bearer {{API_KEY}}'; 4 5const endpointUrl = new URL('https://person.clearbit.com/v1/people/{{ID}}/flag'); 6 7const headerParameters = { 8 authorization: API_KEY, 9 contentType: 'application/json', 10}; 11 12const options = { 13 method: 'POST', 14 headers: headerParameters, 15}; 16 17async function fetchData() { 18 try { 19 const response = await fetch(endpointUrl, options); 20 21 // 自定义函数:打印 API 响应 22 printResponse(response); 23 } catch (error) { 24 // 自定义函数:打印错误信息 25 printError(error); 26 } 27} 28 29// 调用函数发起 API 请求 30fetchData();