ecomailcz/webareal-client

用于与 Webareal.cz API 交互的基本客户端

v1.1 2020-05-13 08:48 UTC

This package is auto-updated.

Last update: 2024-08-29 05:00:49 UTC


README

安装

composer require ecomailcz/webareal-client

使用

<?php
$username = '<vaše přihlašovací jméno>';
$password = '<vaše přihlašovací heslo>';
$apiKey = '<váš API klíč>';

$credentials = new \Ecomailcz\Webareal\Credentials($username, $password, $apiKey); 
$api = new \Ecomailcz\Webareal\Client($credentials);

$orders = $api->requestGet('orders', [
    'limit' => 10,
    'sortBy'=>'id',
    'sortDirection'=>'desc'
]);

您可以在账户管理中的“其他服务”>“API”部分找到API密钥。

API文档可在以下地址找到: https://webareal.docs.apiary.io/

其他功能

Token缓存

Wrapper会自动从API登录凭据中获取访问数据的所需token。为了节省请求,该包提供Token缓存,该缓存会在1小时内记住最后一个有效的token。

默认缓存只会在内存中存储Token,当脚本结束时,这些内存将被释放。库还支持将缓存保存到文件中,只需在创建库时将缓存传递给库即可。

<?php
$cache = new \Ecomailcz\Webareal\TokenCache\FileCache(__DIR__ . '/temp');
$api = new \Ecomailcz\Webareal\Client($credentials, $cache);

SSL CA包

如果服务器上没有正确安装当前的CA证书包,那么与API服务器的连接可能会因错误而失败。

curl: (60) SSL certificate problem: Invalid certificate chain
More details here: https://curl.haxx.se/docs/sslcerts.html

在这种情况下,您只需在您的应用程序中安装包 composer/ca-bundle,Wrapper会自动使用它来连接到服务器。

composer require composer/ca-bundle