Skip to content
UKFast SDK for PHP
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update feature_request.md May 16, 2019
examples split account client into entity clients May 19, 2019
src Merge pull request #25 from gmann1982/master May 23, 2019
tests
.gitignore
.travis.yml Cache composer packages so "composer install" is faster Apr 29, 2019
CONTRIBUTING.md
LICENSE Initial commit Apr 22, 2019
README.md
composer.json
phpcs.xml
phpunit.xml Implemented base client and PSS client Apr 24, 2019

README.md

UKFast API PHP client

Build Status MIT licensed

Currently in beta

SDK is still in development but will be fully released shortly. It's unlikely that the interface will change significantly, but it's possible that some breaking changes will be made.

A PHP client 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/client

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.

Example

<?php

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

$page = $client->getRequests();

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

Contributing

We welcome contributions that will benefit our users, please see CONTRIBUTING for details on how to get involved.

License

This SDK is released under the MIT License

You can’t perform that action at this time.