ApiDQ API PHP Client
This is the PHP ApiDQ API client. This library allows using of the actual API version. You can find more info in the documentation.
Installation
Follow those steps to install the library:
- Download and install Composer package manager.
- Install the library from the Packagist by executing this command:
composer require nikitaksv/apidq-client-php:"~1.0"
Note: API client uses php-http/client-implementation as a PSR-18, PSR-17 implementation. You can replace those implementations during installation by installing this library with the implementation of your choice, like this:
composer require symfony/http-client guzzlehttp/psr7 nikitaksv/apidq-client-php:"~1.0"
Usage
Firstly, you should initialize the Client. The easiest way to do this is to use the SimpleClientFactory:
$client = \ApiDQ\Factory\SimpleClientFactory::createClient('https://api.apidq.io', 'apiKey');
$client = \ApiDQ\Factory\SimpleClientFactory::createClientWithCache('https://api.apidq.io', 'apiKey', $psrCache);
$client = \ApiDQ\Factory\SimpleClientFactory::createClientWithFileCache('https://api.apidq.io', 'apiKey', sys_get_temp_dir());
The client is separated into several resource groups, all of which are accessible through the Client's public properties. You can call API methods from those groups like this:
$cleanResponse = $client->address->clean(
(new \ApiDQ\Model\Service\Address\CleanRequest())
->setQuery('Москва')
->setCountryCode('RU')
);
To handle errors you must use two types of exceptions:
ApiDQ\Exception\Service\ServiceExceptionfor the api service error.ApiDQ\Exception\Client\BuilderExceptionfor the client builder error.
4 May 23, 2022
10 Mar 22, 2022
275 Jan 5, 2023
14 Nov 18, 2021
2 Sep 28, 2021
2 Sep 24, 2021
106 Nov 22, 2022
1 Nov 13, 2021
8 Mar 8, 2022
160 Oct 16, 2022
6 Nov 2, 2022
11 Sep 22, 2022
28 May 12, 2022
2 Sep 26, 2021
2 Nov 3, 2022
1 Nov 5, 2021
8 May 6, 2022
1.4k Dec 14, 2022