README

这是一个简单的 Companies House API API 客户端。

安装

此客户端可以使用 Composer 安装

composer require dljfield/companies-house

端点

此客户端目前至少支持以下 Companies House API 端点的一部分

用法

要使用此客户端，您必须创建一个 DLJField\CompaniesHouse\Client 实例，并将您的 Companies House API 密钥传递给构造函数。

响应

所有端点都返回一个命名类作为响应。

除 DocumentContents 类型外，这些类都是简单的数据对象，包含 API 调用的响应内容。因此，您可以像访问任何其他简单数据对象一样遍历它们并访问它们。例如。

$companyProfile = $companiesHouseClient->getCompanyProfile($companyNumber);

foreach ($companyProfile as $field) {
    echo $field;
}

echo $companyProfile->next_accounts->due_on;

DocumentContents 有两个字段

$content
$contentLength

内容应该是可以直接流式传输到浏览器的文件，例如。

$pdfFile = $companiesHouseClient->getDocumentContents($documentId, DocumentContents::CONTENT_TYPE_PDF);

header("Content-type: application/octet-stream");
header("Content-disposition: attachment;filename=filing-history-document.pdf");

echo $pdfFile->content;
exit;

异常

如果 API 调用失败，将抛出异常。除了正常的异常消息外，这些异常还包含一个 statusCode 参数、一个 reason 参数和一个 contents 参数。这些是 API 响应的状态码、与该状态码关联的原因短语以及从 Companies House API 返回的任何响应体（例如它们自己的错误）。

dljfield / companies-house

维护者

详细信息

README

安装

端点

用法

响应

异常