api-check/php-laravel-client

ApiCheck wrapper for Laravel

1.1 2022-10-09 16:53 UTC

Requires

• php: ^7.1|^8.0
• api-check/php-client: ^1.0
• illuminate/support: ^6.0 | ^7.0 | ^8.0 | ^9.0

Requires (Dev)

• phpunit/phpunit: ^9.5

MIT

• ApiCheck

README

This is a Laravel PHP client for ApiCheck endpoints. ApiCheck helps you validate customer data.

Currently supported countries: The Netherlands, Belgium, and Luxembourg.

Requirements

• Register an account at ApiCheck Dashboard and select the appropriate subscription type.
• Create a new API key.

Installation

Use composer to install this package

$ composer require apicheck/php-laravel-client:^1.0

{
  "require": {
    "apicheck/php-laravel-client": "^1.0"
  }
}

Examples

The first step is to add the APICHECK_API_KEY variable to your .env file:

APICHECK_API_KEY = "xxxxxxxxxxx"

Use the Lookup API

The lookup API is currently only supported for NL and LU. See: Lookup API documentation

Use the Lookup API

$address = ApiCheck::api()->lookup('nl', 'postalcode' => '2513AA', 'number' => 1]);

// Do something with the result:
print("🥳 Yay! We have a result: \n $address->street $address->number \n $address->postalcode $address->city \n {$address->Country->name}");

Use the Search API

The search API is currently supported for NL, BE, LU and FR. See: Search API documentation

$results = ApiCheck::api()->search('be', 'city', ['name' => 'Namur']);

This will return an array with the search results

Exceptions

The ApiCheck client uses custom Exceptions to handle failure responses:

use ApiCheck\Api\ApiClient;
use ApiCheck\Api\Exceptions\NotFoundException;
use ApiCheck\Api\Exceptions\ValidationException;
use ApiCheck\Api\Exceptions\UnsupportedCountryException;

try {
    $address = $apicheckClient->lookup('nl', ['postalcode' => '2513AA', 'number' => 1]);
} catch (NotFoundException $e) {
    // No results have been found using the supplied data
} catch (ValidationException $e) {
    // One of the submitted fields is not valid or set
} catch (UnsupportedCountryException $e) {
    // The given country-code is not supported
}

More examples can be found in the examples directory.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

Support

Contact: www.apicheck.nl — [e-mail]