levelfiveteam / govuk-companieshouse-php-sdk

v1.1 2020-01-24 21:59 UTC

README

这是使用PHP实现的Companies House集成。

这个仓库在项目中积极使用,我们将定期维护它。

Build Status Total Downloads Latest Stable Version Latest Unstable Version Coverage Status License

说明

这是Companies House PHP SDK套件,允许您提供完整的访问公司和验证公司的功能。

  1. 只需将您的应用程序设置为将服务作为工厂存储;
$companiesHouse = new CompaniesHouse('api_key');
  1. 根据需要创建命令和查询(以下示例返回API版本响应);

示例查询

$response = $companiesHouse->handle(new GetCompanyByCompanyNumber(['company_number' => '12341234']));

示例命令

$command = new GetCompanyByCompanyNumber(['company_number' => '12341234']);
$company = $companiesHouse->handle($command);

您不需要使用此服务进行数据验证。验证在命令级别进行。任何验证错误将作为带有JSON错误消息的 DomainException 返回。

有效的响应将是一个不可变对象,您可以选择查看完整的响应。

重要说明;我们正在积极添加新的命令。

提交错误报告和功能请求

错误报告和功能请求在 GitHub 上跟踪。

我们正在积极更新SDK套件。

许可

您可以在非商业用途中免费重用和修改此内容,并注明出处。请查阅许可协议以获取更多信息。