README

停止

由于 Neustar 购买了 EveryoneAPI 并且拒绝为爱好者提供任何类型的服务访问，该项目正式停止。

介绍

EveryonePHP 是一个用于查询 EveryoneAPI 的 PHP 库。原始代码作为 CNAM-CLI 和 webCNAM 的一部分开发，之后被分叉为一个独立的库。如果您需要 EveryoneAPI 的 Python 模块，请考虑尝试 EveryoneAPI.py。

为了使用 EveryonePHP，您必须拥有一个 EveryoneAPI 账户并且有可用的资金。

安装

强烈推荐使用 Composer 在您的项目中安装 EveryonePHP。Composer 将允许您自动安装 GuzzleHttp 库，这是 EveryonePHP 所依赖的。

安装 Composer
切换到您的项目目录
运行 composer require cedwardsmedia/everyonephp
构建您的精彩项目！

用法

我从未是一个伟大的程序员。因此，我努力使 EveryonePHP 尽可能简单易用，并且我总是希望进一步简化它。让我们使用 EveryonePHP 构建一个基本的 EveryoneAPI 客户端。

步骤 1: 实例化 EveryonePHP 为对象

// Instantiate EveryonePHP
$api = new EveryonePHP();

创建一个新的 EveryonePHP 对象使我们能够与该类交互。

步骤 2: 设置 EveryoneAPI 凭据

// Set EveryoneAPI Credentials
$api->sid = "9e3cef42da225d42bd86feaa80ff47";
$api->token = "65f3ef01462c62f7f4ce7d2156ceee";

EveryonePHP 需要这些凭据才能查询 EveryoneAPI。否则，查询将失败。您如何获取和存储这些凭据完全取决于您，只需确保在调用 query() 之前为每个 EveryonePHP 实例设置它们即可。

步骤 3: 设置 EveryoneAPI 数据点

// Set EveryoneAPI Data Points
$data = array("name", "profile", "cnam", "gender", "image", "address", "location", "line_provider", "carrier", "carrier_o", "linetype");

每个数据点都是可选的，并且默认返回所有数据点，除非另有说明。同样，EveryoneAPI 使用逗号分隔的标识符列表，EveryonePHP 使用简单的数组来指定您希望检索的数据点。EveryonePHP 直接将这些标识符传递给 EveryoneAPI，因此您在这里将使用与 cURL 请求中相同的标识符。

有关可用数据点的完整列表，请参阅 EveryoneAPI 文档。

步骤 4: 执行 EveryoneAPI 查询

// Perform EveryoneAPI query
$api->query($phone, $data);

此函数仅需要 $phone。该函数将对 EveryoneAPI 执行查询并将结果存储在 stdClass 对象中，在本例中为 $api->results。

步骤 5: 打印结果

// Print results

// Print first name
echo $api->results->data->expanded_name->first;

// Print last name
echo $api->results->data->expanded_name->last;

// Print carrier name
echo $api->results->data->carrier->name;

EveryonePHP 将 EveryoneAPI 的 JSON 响应转换为 stdClass 对象。这允许我们访问整个响应，以便在我们的应用程序中使用。在上面的示例中，我们打印了给定电话号码的姓名、姓氏和运营商。

可选：错误检查

// Check for Error
if ($api->error) {               // If there's an error
   echo "Error: $api->error";    // Print it out
   exit(1);                      // Exit with status 1
}

如果发生错误，EveryonePHP 将错误消息分配给 $api->error。您可以使用此处的 if 语句，如上所述，在出现错误时停止您的应用程序。

贡献

分叉它！
创建您的功能分支：git checkout -b my-new-feature
提交您的更改：git commit -am '添加一些功能'
推送到分支：git push origin my-new-feature
提交拉取请求 ^_^,

鸣谢

概念和原始代码库：Corey Edwards (@cedwardsmedia)

优化和调试：Brian Seymour (@eBrian)

许可证

EveryonePHP 使用 BSD 简化许可证 许可。请参阅 LICENSE 获取更多信息。

免责声明：EveryonePHP 未得到 OpenCNAM、EveryoneAPI 或 Telo USA, Inc 的认可、赞助或任何其他形式的关联。

cedwardsmedia / everyonephp

维护者

详细信息