m1guelpf/sqreen-api

PHP Client for the Sqreen API

PHP Sqreen API Client

, _(*1)

This package makes it easy to interact with the Sqreen API., _(*2)

Requirements

This package requires PHP >= 5.5., _(*3)

Installation

You can install the package via composer:, _(*4)

``` bash composer require m1guelpf/sqreen-api, <sub>(*5)</sub>

## Usage

You must pass a Guzzle client and the API token to the constructor of `M1guelpf\SqreenAPI\Sqreen`.

``` php
$sqreen = new \M1guelpf\SqreenAPI\Sqreen('YOUR_SQREEN_API_TOKEN');

or you can skip the token and use the connect() method later, <sub>(*6)</sub>

``` php $sqreen = new \M1guelpf\SqreenAPI\Sqreen();, <sub>(*7)</sub>

$sqreen->connect('YOUR_SQREEN_API_TOKEN');, <sub>(*8)</sub>

### Get Email info
``` php
$sqreen->emails($email);

Get IP info

``` php $sqreen->ips($ip);, <sub>(*9)</sub>

### Get the Guzzle Client

``` php
$sqreen->getClient();

Set the Guzzle Client

``` php $client = new \GuzzleHttp\Client(); // Example Guzzle client $sqreen->setClient($client);, <sub>(*10)</sub>

where $client is an instance of `\GuzzleHttp\Client`.

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Testing

``` bash
$ composer test

Contributing

Please see CONTRIBUTING for details., <sub>(*11)</sub>

Security

If you discover any security related issues, please email soy@miguelpiedrafita.com instead of using the issue tracker., <sub>(*12)</sub>

Credits

• Miguel Piedrafita
• All Contributors

License

The Mozilla Public License 2.0 (MPL-2.0). Please see License File for more information., <sub>(*13)</sub>