README

Clearbit API 客户端。目前支持富化 API，但整个 API 的实现也在计划中。当前实现使用 v2 端点。

安装

通过 Composer

$ composer require wlbrough/clearbit-api

快速入门

此实现支持使用一个或多个 API 密钥。如果使用单个密钥，则使用静态函数生成客户端，否则使用实例方法生成客户端。

使用单个密钥

以下所有示例都假设以下步骤

use wlbrough\clearbit\Clearbit;

Clearbit::setKey('token');

配置端点行为

默认情况下，如果数据不可用，Clearbit 会将数据发送到 webhook。您可以为接收 webhook 配置端点 URL，或者您可以使用流式 API 等待结果。

$enrichment = Clearbit::createEnrichmentApi();

// Webhook endpoint
$enrichment->setWebhookEndpoint('https://test.com/api/webhook');

// Streaming
$enrichment->enableStreaming();

获取组合（人员和公司）数据

$enrichment = Clearbit::createEnrichmentApi();
$enrichment->combined('test@test.com');

获取人员数据

$enrichment = Clearbit::createEnrichmentApi();
$enrichment->person('test@test.com');

订阅更新

$enrichment = Clearbit::createEnrichmentApi();
$enrichment->person('test@test.com', true);

获取公司数据

$enrichment = Clearbit::createEnrichmentApi();
$enrichment->company('test.com');

姓名到域名

$nameToDomain = Clearbit::createNameToDomain();
$nameToDomain->get('Segment');

状态

富化
发现
勘探者
风险
揭示
姓名到域名
标志

变更日志

请参阅 CHANGELOG 了解最近更改的详细信息。

测试

$ composer test

贡献

请参阅 CONTRIBUTING 和 CODE_OF_CONDUCT 了解详细信息。

安全性

如果您发现任何与安全相关的问题，请通过电子邮件 wlbrough@gmail.com 而不是使用问题跟踪器。

致谢

许可

MIT 许可证（MIT）。有关更多信息，请参阅许可文件。

wlbrough / clearbit-api

维护者

详细信息