Download the PHP package api-check/php-client without Composer
On this page you can find all versions of the php package api-check/php-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download api-check/php-client
More information about api-check/php-client
Files in api-check/php-client
Package php-client
Short Description A wrapper around ApiCheck API to validate addresses.
License MIT
Homepage https://apicheck.nl/
Informations about the package php-client
ApiCheck PHP Client
A PHP client for the ApiCheck API. Validate addresses, search locations, and verify contact data with ease.
Version: 2.0.0
Features
- Lookup API - Validate postal addresses (NL, LU)
- Search API - Search cities, streets, postal codes, and addresses across 18 European countries
- Verify API - Verify email addresses and phone numbers
Requirements
- PHP 8.1 or higher
- Register an account at ApiCheck Dashboard
- Create an API key
Installation
Install via Composer:
Or add to your composer.json:
Quick Start
Lookup API
Look up addresses by postal code and house number. Currently supported for NL and LU.
Basic Lookup
Advanced Options
Get Number Additions
Retrieve available number additions (like "A", "B", "1e") for a postal code:
Search API
Search for cities, streets, postal codes, and addresses across 18 European countries.
Basic Search
Global Search
Search across all scopes at once:
Belgium-Specific Searches
Search localities (deelgemeenten) and municipalities (gemeenten):
Address Resolution
Resolve a full address using IDs from previous searches:
Get Supported Countries
Retrieve the live list of supported countries:
Verify API
Verify email addresses and phone numbers.
Email Verification
Phone Number Verification
Exception Handling
The client uses specific exceptions for different error scenarios:
Available Exceptions
ApiException- Base exception for all API errorsAccessDeniedException- Access deniedApiKeyExhaustedException- API key quota exceededApiKeyHeaderException- API key header missingApiKeyInvalidException- Invalid API keyBadRequestException- Bad request (400)HostNotAllowedException- Host not allowed for this API keyInternalServerErrorException- Server error (500)NoExactMatchException- No exact match foundNotFoundException- Resource not found (404)PageNotFoundException- Page not foundUnauthorizedException- Unauthorized (401)UnprocessableEntityException- Unprocessable entity (422)UnsupportedCountryException- Country not supportedValidationException- Validation failed
Examples
More examples can be found in the examples/ directory:
- Lookup examples - Basic lookup, number additions, options
- Search examples - Basic search, global search, Belgium-specific, address resolution
- Verify examples - Email and phone verification
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
Support
Contact: www.apicheck.nl — [email protected]
All versions of php-client with dependencies
ext-curl Version *
ext-json Version *
guzzlehttp/guzzle Version ^7.0