apiship/apidq-client-php

ApiDQ API 的 PHP 客户端

维护者

详细信息

github.com/apiship/apidq-client-php

主页

源代码

问题

安装: 6

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 1

公开问题: 0

v1.0.1 2023-11-08 09:52 UTC

Requires

Requires (Dev)

Suggests

MIT 283a002187e97ff4a76f733ceb97c7ed5769e81c

  • ApiShip <info.woop@apiship.ru>
  • Nikita Krasnikov <nikitaksv97.woop@gmail.com>

restapiclientsdkApidq

This package is auto-updated.

Last update: 2024-09-13 05:53:24 UTC

README

ApiDQ API PHP 客户端

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

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

安装

按照以下步骤安装库

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

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

composer require symfony/http-client guzzlehttp/psr7 apiship/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 用于客户端构建器错误。