README

#Apisdk

postabezhranic 的 API SDK

安装

最简单的安装方式是通过 Composer Composer

$ composer require postabezhranic/Apisdk

如果您不使用 Composer，请将数据下载到您的项目中并使用

require $path . '/Apisdk/src/Request.php';
require $path . '/Apisdk/src/Pbh.php';
require $path . '/Apisdk/src/Item.php';
require $path . '/Apisdk/src/XmlBuilder.php';

其中 $path 是库的路径。

使用方法

使用很简单。首先需要初始化类 \postabezhranic\Apisdk\Pbh 并传入 userId 和 apikey

$pbh = new \postabezhranic\api\Pbh('userId', 'apikey');

然后我们可以使用 addItem 添加包裹。要使用哪些键，您可以在 Item 类中找到或通过我们的内部文档了解。您可以通过电子邮件请求内部文档，在创建客户账户后。在文档中，您还可以了解如何选择运输商等。

// příklad správného balíku
$pbh->addItem([
    'kod' => '2-546',
    'psc' => '110 00',
    'ulice' => '17. listopadu',
    'mesto' => 'Praha 5', 
    'stat' => 'HU',
    'prepravce' => 60,
    'jmeno' => 'Adresát',
]);

// příklad správného balíku se službami
$pbh->addItem([
    'kod' => '2-545',
    'psc' => '110 00',
    'ulice' => '17. listopadu',
    'mesto' => 'Praha 5', 
    'stat' => 'HU',
    'prepravce' => 60,
    'jmeno' => 'Adresát',
    'sluzby' => [
	'sluzba' => [
	    '@attributy' => [
	        'key' => 'val', //vygeneruje <sluzba key="val">
	    ]
	    'nazev' => 'PP',
	    'hodnota' => '1',
	]
    ]
]);

可以添加最多 2000 个包裹

一旦添加了包裹，就需要将它们发送到我们的服务器

$result = $pbh->sendItems();

在 $result 中，我们将以数组的形式收到响应。如果发生错误，则在响应中会收到有关错误的更详细信息。更多信息请参阅我们的内部文档。

获取包裹信息

只需调用 getPackageInfo 方法并传入包裹代码即可

$result = $pbh->getPackageInfo('2-545'); //kod viz example-send-packages
var_dump($result); //výsledek dotazu, pokud je vše dobře, vrátí se state ok

用于履行

添加产品并发送产品到 postabezhranic.cz

$pbh = new Pbh('userId', 'apikey'); //zde zadáme ID uživatele a api klíč


$pbh->useTransactionMode(); 

$pbh->addProduct([
    'productcode' => '1-545',
    'name' => 'test',
    'photo' => 'https://www.postabezhranic.cz/styl/images/logo-posta-bez-hranic.png',
]);

$pbh->addProduct([
    'productcode' => '1-5454',
    'productcodeOther' => 'some-code',
    'name' => 'test2',
    'photo' => 'https://www.postabezhranic.cz/styl/images/logo-posta-bez-hranic.png',
]);


$result = $pbh->sendProducts(); 
var_dump($result);

发送带产品的包裹看起来与传统的包裹发送类似，只需添加要发送的产品即可。

$pbh->addItem([
    'kod' => '2-545',
    'psc' => '110 00',
    'ulice' => '17. listopadu',
    'mesto' => 'Praha 5', 
    'stat' => 'RO',
    'prepravce' => 23,
    'jmeno' => 'Adresát',
    'produkty' => [
	[
	    'id' => '123456789',
	    'mnozstvi' => '1',
	],[
	    'id' => '12345678',
	    'mnozstvi' => '1',
	]
    ]
]);