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上的Pull Requests接受。

拉取请求

记录任何行为变更 - 确保readme.md和任何其他相关文档保持最新。
考虑我们的发布周期 - 我们试图遵循SemVer v2.0.0。随机破坏公共API不是可选项。
每个功能一个拉取请求 - 如果您想做更多的事情，请发送多个拉取请求。

安全性

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

许可证

许可证。请参阅许可证文件获取更多信息。

daveismyname / laravel-companies-house

维护者

详细信息