Download the PHP package ashleighsims/companies-house-api-wrapper without Composer

On this page you can find all versions of the php package ashleighsims/companies-house-api-wrapper. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of ashleighsims/companies-house-api-wrapper

Informations about the package companies-house-api-wrapper

Companies House Api Wrapper

This is a PHP wrapper for the Companies House API. Auto discovery for Laravel has been added so you should be able to use this out of the box with Laravel.

When using this it's best advised to use an environment file to store the API key and base url. This ensures you don't have any API keys sat in the source code of the application and also not committed into any version control.

This currently does not include the Document API which is also available.

Installation

Before you can start using the Companies House API you will need to register your application in your companies house developer account: https://developer.companieshouse.gov.uk/developer/applications

The API Key provided from registering your application with Companies House will be required.

Via Composer

Laravel

If you're using this package in Laravel auto discovery has been enabled so you should be able to hit the ground running (when using Laravel 5.5 and beyond).

if you aren't using Laravel 5.5 and above you will need to manually register some bits...

Register the provider in the app.php file:

Optionally register the Facade:

Please ensure you've added the below environment variables to your .env file before starting.

Environment Variables

Add the following environment variables to your .env file.

Usage

This covers all the endpoints which are currently available on the Companies House Website as of 18th February 2020.

Each endpoint is listed below with code examples. For Laravel users you can type-hint the CompaniesHouseApiWrapper through constructors or through the facade.

Laravel

Dependency Injection Via Controller

Facade

General Usage

Search

Search All

Arguments:

Optional Arguments:

Search Company

Arguments:

Optional Arguments:

Search Officer

Arguments:

Optional Arguments:

Search Disqualified Officer

Arguments:

Optional Arguments:

Company Profile

Get

Arguments:

Registered Office Address

Get

Arguments:

Company Officers

List

Arguments:

Optional Arguments:

Filing History

Get

Arguments:

List

Arguments:

Optional Arguments:

Insolvency

Get

Arguments:

Charges

Get

Arguments:

List

Arguments:

Optional Arguments:

Officer Appointment List

List

Arguments:

Officer Disqualifications

Get Natural

Arguments:

Get Corporate

Arguments:

UK Establishment Companies

List

Arguments:

Persons with Significant Control

List

Arguments:

Optional Arguments:

Get Individual

Arguments:

Get Corporate

Arguments:

Get Legal Persons

Arguments:

List Statements

Arguments:

Optional Arguments:

Get Statement

Arguments:

Get Super Secure Person

Arguments:

Company Registers

Get

Arguments:

Company Exemptions

Get

Arguments:

Change log

Please see the changelog for more information on what has changed recently.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

License

license. Please see the license file for more information.

All versions of companies-house-api-wrapper with dependencies

PHP Build Version
Package Version
Requires illuminate/support Version ~5|~6
guzzlehttp/guzzle Version ^6.5
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package ashleighsims/companies-house-api-wrapper contains the following files

Loading the files please wait ....