nikitaksv / apidq-client-php

ApiDQ API的PHP客户端

维护者

详细信息

github.com/nikitaksv/apidq-client-php

主页

源代码

问题

安装: 5

依赖: 0

建议者: 0

安全性: 0

星标: 2

关注者: 3

分支: 0

公开问题: 0

v1.0.0 2021-09-26 13:15 UTC

Requires

Requires (Dev)

Suggests

Apache-2.0 dfc9df234e277d1ddee56b6d540ac1fc057847fe

  • Nikita Krasnikov <nikitaksv97.woop@gmail.com>

restapiclientsdkApidq

This package is auto-updated.

Last update: 2024-09-26 21:05:45 UTC

README

Latest Stable Version Total Downloads Latest Unstable Version License PHP Version Require codecov

这是PHP ApiDQ API客户端。此库允许使用实际API版本。您可以在文档中找到更多信息。

安装

按照以下步骤安装库

  1. 下载并安装Composer包管理器。
  2. 通过执行以下命令从Packagist安装库
composer require nikitaksv/apidq-client-php:"~1.0"

注意：API客户端使用php-http/client-implementation作为PSR-18、PSR-17实现。您可以在安装期间替换这些实现，通过安装选择实现库，例如：

composer require symfony/http-client guzzlehttp/psr7 nikitaksv/apidq-client-php:"~1.0"

使用方法

首先，您应该初始化客户端。最简单的方法是使用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());

客户端分为几个资源组，所有这些组都可以通过客户端的公共属性访问。您可以像这样调用API方法：

$cleanResponse = $client->address->clean(
    (new \ApiDQ\Model\Service\Address\CleanRequest())
        ->setQuery('Москва')
        ->setCountryCode('RU')
);

要处理错误，您必须使用两种类型的异常

  • ApiDQ\Exception\Service\ServiceException用于API服务错误。
  • ApiDQ\Exception\Client\BuilderException用于客户端构建错误。