, (*1)
, (*2)
Protect your website against automated scripts using the botscout.com API., (*3)
Installation
You can install the package via composer:, (*4)
``` bash
composer require nicolasbeauvais/botscout-client, (*5)
You also need an api key from [botscout.com](http://botscout.com/getkey.htm)
## Usage
You must pass a Guzzle client and an api key to the constructor of NicolasBeauvais\BotScout:
``` php
$client = new \GuzzleHttp\Client();
$botscout = new NicolasBeauvais\BotScout($client, 'api-key');
Multi
Test matches all parameters at once., (*6)
$response = $botscout->multi($name, $mail, $ip);
All
Test matches a single item against all fields in the botscout database., (*7)
$response = $botscout->all($name);
$response = $botscout->all($email);
Name
Test matches a name., (*8)
$response = $botscout->name($name);
Mail
Test matches an email., (*9)
$response = $botscout->mail($mail);
IP
Test matches an IP., (*10)
$response = $botscout->ip($ip);
Response
// Return false if the email has a match in the botscout database
$response->isValid();
// Return true if the email has a match in the botscout database
$response->getMatched();
Changelog
Please see CHANGELOG for more information what has changed recently., (*11)
Testing
bash
$ composer test, (*12)
Contributing
Please see CONTRIBUTING for details., (*13)
Security
If you discover any security related issues, please email nicolasbeauvais1@gmail.com instead of using the issue tracker., (*14)
Credits
License
The MIT License (MIT). Please see License File for more information., (*15)
Wallogit.com
