enrich-data/enrich-api-php

2.0.0 2018-09-27 12:16 UTC

This package is not auto-updated.

Last update: 2024-10-02 04:28:10 UTC


README

Enrich API PHP包装器。从您的PHP服务中丰富、搜索和验证数据。

版权所有 2017 Crisp IM SAS。有关复制信息,请参阅LICENSE。

用法

使用Composer安装库。

然后,导入它

require __DIR__."/vendor/autoload.php";

使用您的user_idsecret_key令牌创建一个新的认证Enrich客户端。

$client = new Enrich();

$client->authenticate("ui_xxxxxx", "sk_xxxxxx");

然后,使用客户端进行消费,例如丰富一个电子邮件地址

$data = $client->enrich->person([
  "email" => "valerian@crisp.chat"
]);

认证

要针对API进行认证,获取您的令牌(user_idsecret_key)。

然后,在实例化Enrich客户端时一次性传递这些令牌,如下所示

// Make sure to replace 'user_id' and 'secret_key' with your tokens
$client->authenticate("user_id", "secret_key");

数据发现

当Enrich不知道某个特定数据点时,例如一个以前从未丰富过的电子邮件,它会启动发现。发现可能需要几秒钟,有时甚至超过10秒钟。

如果发现耗时过长或未找到项目,此库将实现重试逻辑并设置超时。

因此,您可以预料到一些请求,特别是Enrich请求,可能需要比预期更长的时间。这是正常的,并且不是您或我们这一侧的性能问题。在幕后,当您请求一个数据点(例如,使用电子邮件丰富一个人)而该数据点在我们数据库中尚未存在时,Enrich API会返回HTTP响应201 Created。然后,此库将每隔几秒钟轮询丰富资源以获取结果。API会返回404 Not Found,因为发现仍在处理,此时尚无结果。一旦找到结果,API将以200 OK响应并返回发现的数据。如果发现失败且无法为此电子邮件聚合数据,则库在一段时间后(少于20秒)终止重试,并返回一个not_found错误。

如果请求的数据点已经由Enrich API所知,它将立即返回,这不会引起任何延迟。

资源方法

此库实现了Enrich API提供的所有方法。

验证API

验证电子邮件

  • 方法: $client->verify->validateEmail($query)
$data = $client->verify->validateEmail([
  "email" => "valerian@crisp.chat"
]);

Enrich API

丰富一个人

  • 方法: $client->enrich->person($query)
$data = $client->enrich->person([
  "email" => "valerian@crisp.chat"
]);

丰富一个公司

  • 方法: $client->enrich->company($query)
$data = $client->enrich->company([
  "domain" => "crisp.chat"
]);

丰富一个网络

  • 方法: $client->enrich->network($query)
$data = $client->enrich->network([
  "ip" => "178.62.89.169"
]);