ans-group/sdk

ANS SDK for PHP

v1.18.0 2024-11-15 08:17 UTC

Requires

• php: >=5.6
• ext-json: *
• guzzlehttp/guzzle: ^6.3|^7.0

Requires (Dev)

• fzaninotto/faker: ^1.4
• phpunit/phpunit: >=5.7 <=9.5.28
• squizlabs/php_codesniffer: 3.*

MIT

README

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

To use this package, you will need an ANS account. Sign up for free at ans.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 ans-group/sdk

Alternatively, you can download one of our tagged releases for manual installation, we don't recommend cloning the master branch for use in production environments as we cannot guarantee 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