An open API service indexing awesome lists of open source software.

https://github.com/ans-group/sdk-php

ANS SDK for PHP
https://github.com/ans-group/sdk-php

hacktoberfest php sdk

Last synced: 5 months ago
JSON representation

ANS SDK for PHP

Awesome Lists containing this project

README

          

ANS API PHP SDK
=====================
![Build Status](https://github.com/ans-group/sdk-php/actions/workflows/run-tests.yml/badge.svg)
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

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][1],
and refer to the [Getting Started][2] section of our developer documentation for more information on consuming our APIs.

Installation
------------

The recommended way to install this package is through [composer](https://getcomposer.org).

```
composer require ans-group/sdk
```

Alternatively, you can download one of our [tagged releases](https://github.com/ans-group/sdk-php/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
auth('API KEY');

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

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

Contributing
------------

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

License
-------

This SDK is released under the [MIT License](LICENSE)

[1]: https://www.ans.co.uk/book-in-a-call/?utm_source=github&utm_medium=link&utm_campaign=apio
[2]: https://developers.ukfast.io/getting-started?utm_source=github&utm_medium=link&utm_campaign=apio