swiftyper/swiftyper-php

v1.1.1 2024-05-02 14:02 UTC

This package is auto-updated.

Last update: 2024-10-02 15:05:28 UTC


README

文档

swiftyper-php API 文档 for PHP。

需求

PHP 5.6.0+。

Composer

您可以通过 Composer 安装绑定。运行以下命令

composer require swiftyper/swiftyper-php

要使用绑定,使用 Composer 的 自动加载

require_once('vendor/autoload.php');

手动安装

如果您不想使用 Composer,您可以下载 最新版本。然后,为了使用绑定,包含 init.php 文件。

require_once('/path/to/swiftyper-php/init.php');

用法

在开始使用之前,您需要设置 API 密钥,您可以通过您的 用户账户 进行管理。

API 密钥默认无限。 无限制密钥不安全,因为任何人都可以在任何地方使用。对于生产应用,我们建议设置 API 密钥限制,因为它们有助于防止未授权使用和配额耗尽。限制确定哪些网站或 IP 地址可以使用 API 密钥。

\Swiftyper\Swiftyper::setApiKey('API_KEY_OF_SWIFTYPER_BUSINESS');
$results = \Swiftyper\Business::query([
    'query'   => 'Google Slovakia',
    'country' => 'SK',
]);

var_dump($results->toArray());

访问请求的响应

您可以通过 getLastResponse() 方法从任何对象中获取 API 响应的数据。

$business = \Swiftyper\Business::detail('sk_WbilvhDEDokFTWk0FbNjeQ');
var_dump($business->getLastResponse());

配置自动重试

您可以配置库在请求失败时重试一定次数。这在您想要确保即使在网络故障的情况下请求也能成功处理时很有用。

\Swiftyper\Swiftyper::setMaxNetworkRetries(2);