README.md

PHP Sqreen API Client

This package makes it easy to interact with the Sqreen API.

Requirements

This package requires PHP >= 5.5.

Installation

You can install the package via composer:

composer require m1guelpf/sqreen-api

Usage

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

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

or you can skip the token and use the connect() method later

$sqreen = new \M1guelpf\SqreenAPI\Sqreen();

$sqreen->connect('YOUR_SQREEN_API_TOKEN');

Get Email info

$sqreen->emails($email);

Get IP info

$sqreen->ips($ip);

Get the Guzzle Client

$sqreen->getClient();

Set the Guzzle Client

$client = new \GuzzleHttp\Client(); // Example Guzzle client
$sqreen->setClient($client);

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

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

• Miguel Piedrafita
• All Contributors

License

The Mozilla Public License 2.0 (MPL-2.0). Please see License File for more information.