README

为了使用此库，您需要满足以下一些先决条件

• 用从CSR工具收到的证书替换此库中的证书
• 使用您的凭据文档PDF中提供的客户端ID和客户端密钥更新客户端ID和客户端密钥
• 将端点从https://iat-api.adp.com和https://iat-accounts.adp.com更新到https://api.adp.com和https://accounts.adp.com。

ADP Client Userinfo Library for PHP

ADP客户端Userinfo库旨在简化并协助从ADP Marketplace API网关检索Userinfo的过程。该库包含一个示例应用程序，可以直接运行以连接到ADP Marketplace API 测试网关。

此库的安装和使用假设以下内容

• 您必须运行php5.3或更高版本，并支持CURL。如果您正在使用OSX，这意味着您需要重新构建PHP以支持CURL。
• 已安装并配置Composer，因为库使用Composer进行安装。

版本

1.0.2

安装

Composer

使用Composer从您希望用作项目根目录的位置。

$ composer require adpmarketplace/api-userinfo

这将安装Userinfo模块到您的项目中。如果您尚未安装连接模块，它将自动下载并安装。

如果您想构建示例客户端，请执行以下操作

$ cd adplib/connection/tools
$ php makeclient.php

如果您想立即测试，请复制并粘贴由makeclient.php脚本生成的正确命令。如果您错过了它们，也可以这样做

(from the project root)
$ cd client
$ php -S 127.0.0.1:8889

这将在一个端口8889上启动HTTP服务器（此端口必须未使用才能运行示例应用程序）。

运行示例应用程序

注意，要测试示例应用程序，您必须首先运行makeclient.php脚本，然后启动上面概述的PHP服务器。

完成此操作后，打开您的网络浏览器，转到

https://:8889

示例应用程序允许您连接到ADP测试API网关以测试Userinfo调用。请注意，只有“授权码”对于调用Userinfo API是有效的。

示例

调用userinfo（这假设您已经有一个有效的连接）

require("config.php");
require($libroot . "connection/adpapiConnection.class.php");
require($libroot . "userinfo/adpapiUserinfo.class.php");

//--------------------------
// Create the helper class
//--------------------------

try {

    $userInfoHelper = new adpapiUserinfoHelper($adpConn);

}
catch (adpException $e) {

    showADPException($e);
    exit();

}

//-------------------------------------------
// Get the info back from the userinfo call
//-------------------------------------------

try {

    $userInfo = $userInfoHelper->getUserinfo();
}
catch (adpException $e) {

    showADPException($e);
    exit();

}

//-------------------------------------------
// Success.  We have a userinfo value object.
//-------------------------------------------

echo "<h1>User Info</h1>\n";
echo "<pre>";

print_r($userInfo);

echo "</pre>";

API文档

有关库提供的各个API调用的文档位于'doc'文件夹中。在浏览器中打开index.html文件以查看文档。

依赖项

此库有以下依赖项。

• adpmarketplace/api-connection - 通过Composer自动安装。
• PHP版本需大于等于v5.3，并且支持CURL。如果你使用的是OSX系统，这意味着你需要重新构建PHP以支持CURL。
• composer

测试

我们的测试和代码覆盖率是通过PHPUNIT处理的，你必须安装PHPUNIT来运行测试。为了使代码覆盖率生效，你还必须安装Xdebug。测试单元位于"test"文件夹中，phpunit.xml配置已经加载。为了运行测试并查看代码覆盖率

phpunit

代码检查器

你必须使用PHP内置的代码检查器来验证你的代码结构

php -l <sourcefile>

贡献

要为库贡献代码，请发起一个pull request。在发起pull request之前，请确保以下事项

1. 适当的单元测试已被更新或创建。
2. 单元测试的代码覆盖率必须不低于95%。
3. 你的代码更新已经完全测试并通过代码检查器，没有错误。
4. 根据需要更新README.md和API文档。

许可证

本库受Apache 2许可证（https://apache.ac.cn/licenses/LICENSE-2.0）保护。