README

有一个 Discord 社区。 https://discord.gg/VYau8hgwrm 如果需要快速帮助，请在适当的频道中提问。

Laravel 包，用于读取 Companies House。

文档和安装说明

Companies House API 文档可以在以下位置找到：https://developer.company-information.service.gov.uk/api/docs/

应用程序注册

要使用 Companies House，需要在 https://developer.companieshouse.gov.uk/developer/applications 创建应用程序。

安装

记下 API 密钥并将其添加到您的 .env 文件中

COMPANIES_HOUSE_KEY=

通过 Composer

composer require dcblogdev/laravel-companies-house

您可以使用以下命令发布配置文件：

php artisan vendor:publish --provider="Dcblogdev\CompaniesHouse\CompaniesHouseServiceProvider" --tag="config"

发布后，config/companieshouse.php 配置文件将包含

<?php

return [

    /*
    * the key is set from the Companies House to identify the application
    * https://developer.companieshouse.gov.uk/developer/applications
    */
    'key' => env('COMPANIES_HOUSE_KEY'),
];

使用方法

在控制器中导入类

use Dcblogdev\CompaniesHouse\Facades\CompaniesHouse;

在视图或闭包中调用外观

CompaniesHouse::get('path');

您调用 CompaniesHouse 后跟 get::这将执行一个 GET 请求，后跟您要调用的端点，例如，调用公司资料（https://developer.companieshouse.gov.uk/api/docs/company/company_number/company_number.html）

CompaniesHouse::get('company/123456');

为了使事情更简单，还提供了特质类

每个特质类都提供了方便的方法，这些方法调用端点，处理数据，并返回结果的 JSON。

搜索

搜索所有索引信息。

CompaniesHouse::search($term)

搜索公司

CompaniesHouse::searchCompany($term)

搜索官员

CompaniesHouse::searchOfficer($term)

搜索被除名的官员

CompaniesHouse::searchOfficerDisqualified($term)

公司

获取公司

CompaniesHouse::getCompany($companyNumber)

获取公司地址

CompaniesHouse::getCompanyAddress($companyNumber)

获取公司官员

CompaniesHouse::getCompanyOfficer($companyNumber)

获取公司提交

CompaniesHouse::getCompanyFiling($companyNumber)

获取公司提交项

CompaniesHouse::getCompanyFilingItem($companyNumber)

获取公司破产

CompaniesHouse::getCompanyInsolvency($companyNumber)

获取公司抵押品

CompaniesHouse::getCompanyCharge($companyNumber)

获取公司抵押品项

CompaniesHouse::getCompanyChargeItem($companyNumber)

获取公司成立信息

CompaniesHouse::getCompanyEstablishment($companyNumber)

获取公司登记册

CompaniesHouse::getCompanyRegister($companyNumber)

获取公司豁免

CompaniesHouse::getCompanyExemption(($companyNumber)

官员

获取官员任命

CompaniesHouse::getOfficerAppointment($officerId)

获取官员除名

CompaniesHouse::getOfficerDisqualification($officerId)

获取公司除名

CompaniesHouse::getOfficerDisqualificationCorp($officerId)

变更日志

请参阅 变更日志 了解最近更改的详细信息。

贡献

欢迎贡献，并将得到充分认可。

通过 Github 的拉取请求接受贡献。

拉取请求

• 记录任何行为变更 - 确保readme.md和任何其他相关文档保持最新。

• 考虑我们的发布周期 - 我们试图遵循 SemVer v2.0.0。 随意破坏公共 API 不是选项。

• 每个特性一个拉取请求 - 如果你想做更多的事情，请发送多个拉取请求。

安全

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

许可证

许可证。请参阅 许可证文件 了解更多信息。