跳转到主要内容
POST
https://api.aisa.one/apis/v1
/
apollo
/
people
/
match
人员信息补充
curl --request POST \
  --url https://api.aisa.one/apis/v1/apollo/people/match \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.aisa.one/apis/v1/apollo/people/match"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.aisa.one/apis/v1/apollo/people/match', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/apollo/people/match",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.aisa.one/apis/v1/apollo/people/match"

req, _ := http.NewRequest("POST", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/apollo/people/match")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/apollo/people/match")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "person": {},
  "waterfall": {}
}

授权

Authorization
string
header
必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

查询参数

first_name
string

人员的名字。通常与 last_name 参数结合使用。示例:tim

last_name
string

人员的姓氏。通常与 first_name 参数结合使用。示例:zheng

name
string

人员的全名。通常由名字和姓氏组成,并以空格分隔。如果使用此参数,则无需使用 first_name 和 last_name 参数。示例:tim zheng

email
string

此人的电子邮件地址。示例:example@email.com

hashed_email
string

人员电子邮件地址的哈希值。电子邮件地址应符合 MD5 或 SHA-256 哈希格式。示例:8d935115b9ff4489f2d1f9249503cadf (MD5) 或 97817c0c49994eb500ad0a5e7e2d8aed51977b26424d508f66e4e8887746a152 (SHA-256)

organization_name
string

此人的雇主名称。可以是当前雇主或前雇主。示例:apollo

domain
string

此人的雇主域名。可以是当前雇主或以前雇主的域名。请勿包含 www.、@ [blocked] 符号或类似内容。示例:apollo.io 或 microsoft.com

id
string

人员的 Apollo ID。Apollo 数据库中的每个人员都分配有唯一 ID。要查找 ID,请调用 People API Search 端点,并确定 person_id 的值。示例:587cf802f65125cad923a266

linkedin_url
string

此人的 LinkedIn 个人资料 URL。示例:http://www.linkedin.com/in/tim-zheng-677ba010

run_waterfall_email
boolean

设为 true 以启用电子邮件瀑布式数据丰富

run_waterfall_phone
boolean

设置为 true 以启用电话瀑布式数据补充

reveal_personal_emails
boolean

如果希望使用个人电子邮件地址丰富此人的数据,请设置为 true。这可能会消耗 Apollo 定价方案中的额度。默认值为 false。如果此人居住在符合 GDPR 要求的地区,Apollo 将不会披露其个人电子邮件地址。

reveal_phone_number
boolean

如果希望使用所有可用电话号码(包括手机号码)丰富此人的数据,请设置为 true。根据你的 Apollo 定价方案,这可能会消耗额度。默认值为 false。如果将此参数设置为 true,则必须为 webhook_url 参数输入 Webhook URL。Apollo 将异步验证电话号码,然后向你提供的 Webhook URL 发送仅包含此人电话号码详细信息的 JSON 响应。电话号码可能需要几分钟才能送达。

webhook_url
string

如果将 reveal_phone_number 参数设置为 true,则此参数为必填项。否则,请勿使用此参数。输入 Webhook URL,以指定 Apollo 应将包含所请求电话号码的 JSON 响应发送到何处。Apollo 建议测试此流程,确保你能够收到包含电话号码的单独响应。如果电话号码未发送到 Webhook URL,请尝试对 Webhook URL 应用 UTF-8 编码。示例:https://webhook.site/cc4cf44e-e047-4774-8dac-473d28474e40;https%3A%2F%2Fwebhook.site%2Fcc4cf44e-e047-4774-8dac-473d28474e40

响应

成功响应

person
object

响应对象

waterfall
object

响应对象