Download the PHP package craigpotter/fca-php-sdk without Composer

On this page you can find all versions of the php package craigpotter/fca-php-sdk. 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 craigpotter/fca-php-sdk

Informations about the package fca-php-sdk

FCA API SDK for PHP

Latest Version on Packagist Tests Total Downloads

This is an unofficial PHP SDK for FCA's API and is powered by Saloon.

Note: This SDK is still in development and is not yet ready for production use. Use at your own risk.

Installation

You can install the package via composer:

Requirements

You will need to have a valid API key from FCA to use this SDK.

You can obtain one by registering as a developer.

Example Usage

Documentation

Warning: This documentation is still a work in progress.

Some responses have the option of a DTO (Data Transfer Object) which can be used to access the response data.

This does not work for all responses, but is documented where it is available.
For all other responses, you can access the raw JSON response using $response->json().

Firms

Check an FRN exists

Get a firm by FRN

Get the individuals associated with a firm by FRN

This endpoint is paginated and will return a maximum of 20 results per page.
You should loop through the pages to get all results.

Get the addresses associated with a firm by FRN

This endpoint is paginated and will return a maximum of 20 results per page.
You should loop through the pages to get all results.

Testing

Copy .env.example to .env and update accordingly.

Credits

License

The MIT License (MIT). Please see License File for more information.

All versions of fca-php-sdk with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
saloonphp/saloon Version ^3.0
saloonphp/pagination-plugin Version ^2.0
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 craigpotter/fca-php-sdk contains the following files

Loading the files please wait ....