README

#Listonoska/API

##安装

最佳的安装方式是使用 Composer Composer

$ composer require listonoska/API

##使用

使用示例可以在 Examples 文件夹中找到

###首先需要获取令牌

$token = new \Listonoska\API\Token('client_id', 'secret');
$token->getToken(); // vrátí token

###然后我们可以获取索引

$listOfValues = new Listonoska\API\ListsOfValues($token);
$listOfValues->getDeliveryTypes(); // číselník typů dodání
$listOfValues->getPrintTypes(); // číselník typů tisku
$listOfValues->getIsoCodes(); // číselník iso kódů

###当知道所有信息后，我们可以发送邮件

$data = array(
    'letterName' => 'test',
    'deliveryType' => 169,
    'printType' => 0,
    'senderCompany' => 'firma',
    'senderPerson' => 'Jan Novák',
    'senderStreet' => 'Palackého',
    'senderHouseNumber' => 15,
    'senderOrientationNumber' => 5,
    'senderCity' => 'Praha',
    'senderZip' => '110 00',
    'addresse' => array( 
	array( // první adresát
	    'person' => 'Radek Novák',
	    'street' => 'Lebedova',
	    'city' => 'Praha',
	    'zip' => '110 00',
        ),
	array( // druhý adresát
	    'person' => 'Radek Novotný',
	    'street' => '17.listopadu',
	    'city' => 'Praha',
	    'zip' => '110 00',
        ),	
    ),
    'pdf1' => new CurlFile( realpath(__DIR__ . '/example.pdf')) // pdf soubor
);

$letter = new Listonoska\API\Letter($token); 
$response = $letter->sendLetter($data); // odešleme dopis, vrátí se nám info o odeslaném dopisu

在邮件中，我们可以发送多个。可以发送的内容请参阅文档。

###还可以获取挂号信的挂号单（挂号单可能不是立即从您的提交中可用）

$letter = new Listonoska\API\Letter($token); 
$response = $letter->getPostalReceipt($letterId); // id dopisu získáme z odpovědi po odeslání dopisu

###邮件可以分页，如果需要取消某个邮件，则可以取消。取消可以到捷克邮政处理之前。

$letter = new Listonoska\API\ListsOfValues($token);
$response = $letter->cancelLetter($letterId);

成功时返回 $response->cancelled = 1

失败时返回错误状态

$response->status; // error
$response->errors[0]->code; // 1, 2 , 3

// 1 = Letter is already canceled
// 2 = Letter cannot be canceled because is already sent
// 3 = Letter has multiple addresses therefore, can not be canceled

注意！！！ 不可以取消已分配多个地址的邮件。因为这会导致问题，即某些邮件可能已经提交，而某些邮件尚未提交。因此，如果您想使用此功能，请始终使用一个收件人地址提交邮件。

listonoska / api

维护者

详细信息

README