Skip to content
master
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 

UKFast API PHP SDK

Build Status MIT licensed

A PHP library for connecting your application(s) to the UKFast APIs.

To use this package, you will need a UKFast account. Sign up for free at ukfast.co.uk, and refer to the Getting Started section of our developer documentation for more information on consuming our APIs.

Installation

The recommended way to install this package is through composer.

composer require ukfast/sdk

Alternativly you can download one of our tagged releases for manual installation, we dont recommend cloning the master branch for use in production environments as we cannot guarentee its stability.

This package does currently support PHP 5.6+, but we recommend moving to 7.1+ as soon as possible.

Usage

Each API has its own client class that extends from a base client class. All clients have an auth method which takes an API token to be used when sending requests.

Each client class has its own subclients, which can be accessed via methods on the base client.

Example

<?php

$client = (new \UKFast\SDK\PSS\Client)->auth('API KEY');

$page = $client->requests()->getPage();

foreach ($page->getItems() as $request) {
    echo "#{$request->id} - {$request->subject}\n";
}

Contributing

We welcome contributions that will benefit other users, please see CONTRIBUTING for details on how you can get involved.

License

This SDK is released under the MIT License