README

Knihovna pro komunikaci s datovou schránkou v PHP.

Instalace pomocí Composeru

composer require davidfoltyn/czech-data-box

Příklady

Níže uvedené příklady používají Defr\CzechDataBox\DataBoxSimpleApi, které nabízí jednodušší přístup k datové schránce. Pokud chcete použít standardní přístup, můžete využít tyto web services:

<?php

$dataBox->DmOperationsWebService();
$dataBox->DmInfoWebService();
$dataBox->DataBoxSearch();
$dataBox->DataBoxAccess();
$dataBox->IsdsStat();

Připojení k datové schránce

<?php

require "../vendor/autoload.php";

use Defr\CzechDataBox\DataBox;

$dataBox = new DataBox();
$dataBox->loginWithUsernameAndPassword("login", "heslo", true); // Pro ostrou verzi
$dataBox->loginWithUsernameAndPassword("login", "heslo", false); // Pro verzi s testovacím přístupem
$dataBox->loginWithCertificateAndPassword("certifikat.cer"); // Nebo pouzijte prihlaseni certifikatem

/** @var \Defr\CzechDataBox\DataBoxSimpleApi $simpleApi */
$simpleApi = $dataBox->getSimpleApi();

Informace o datové schránce

$simpleApi->getDataBoxInfo(); // vrací Defr\CzechDataBox\Api\tDbOwnerInfo

Informace o přihlášeném uživateli

$simpleApi->getUserInfo(); // Vrací Defr\CzechDataBox\Api\tDbUserInfo;

Informace o expiraci hesla

$simpleApi->getPasswordExpires(); // \DateTime|null

Stažení přijatých zpráv

$days = 90;
$limit = 1000;

$messages = $simpleApi->getListOfReceivedMessages($days, $limit);
foreach ($messages as $message) {
    echo "<h2>Msg# " . $message->getDmID() . "</h2>";
    // Defr\CzechDataBox\Api\tIdDm
    var_dump($message);

    echo "<h3>Signed message</h3>";
    // Defr\CzechDataBox\DataBoxMessageFile
    var_dump($simpleApi->downloadSignedReceivedMessage($message->getDmID()));

    echo "<h3>Delivery info</h3>";
    // Defr\CzechDataBox\DataBoxMessageFile
    var_dump($simpleApi->downloadDeliveryInfo($message->getDmID()));

    echo "<h3>Attachments</h3>";
    // Defr\CzechDataBox\DataBoxMessageAttachment[]
    var_dump($simpleApi->getReceivedDataMessageAttachments($message->getDmID()));
}

Stažení odeslaných zpráv

$messages = $simpleApi->getListOfSentMessages();
foreach ($messages as $message) {
    echo "<h2>Msg# " . $message->getDmID() . "</h2>";
    var_dump($message);

    echo "<h3>Signed message</h3>";
    var_dump($simpleApi->downloadSignedSentMessage($message->getDmID()));

    echo "<h3>Delivery info</h3>";
    var_dump($simpleApi->downloadDeliveryInfo($message->getDmID()));
}

Nalezení datové schránky na základě jejího ID

$simpleApi->findDataBoxById('wucb4dd');

Odeslání datové zprávy včetně přílohy

Datová schránka nepřijímá všechny typy souborů, testováno na pdf, jpg, png (Většina binary typů by měla projít). TXT soubory lze odeslat pouze, kdyz se 2x base64 encodují, výsledkem je přijatá datová zpráva s base64 encodovaným contentem uvnitř txt souboru

$files = [
    '/path/to/a/file.pdf',
];
$message = $simpleApi->createBasicDataMessage('wucb4dd', 'Test', $files);
$sentMessage = $simpleApi->sendDataMessage($message);
if ($sentMessage->getDmStatus()->getDmStatusCode() !== "0000") {
    // Handle errors
}

Odeslání VODz datové zprávy včetně přílohy

Příklad odeslání VoDZ. Nejprve se provádí nahrání přílohy metodou UploadAttachment, v response jsou vrácené HASH řetězce které se následně odesílají při sestavení VoDZ zprávy.

// nahrani souboru VoDZ
$uploadAttachment = $this->getUploadAttachment();
$responseUploadAttachment = $vodzClient->UploadAttachment($uploadAttachment);

$envelope = $this->getBigEnvelope();
$dmExtFile = $this->getDmExtFile($responseUploadAttachment);

// nahrani běžné přílohy
$attachments2 = $this->getDmFile();

$dmFiles = new dmFiles();
$dmFiles->setDmExtFile($dmExtFile);
$dmFiles->setDmFile($attachments2[0]);

// vytvoření VoDZ zprávy
$bigMessage = new tBigMessageInput();
$bigMessage->setDmEnvelope($envelope);
$bigMessage->setDmFiles($dmFiles);

// odeslání zprávy
$sentMessage = $vodzClient->CreateBigMessage($bigMessage);
if ($sentMessage->getDmStatus()->getDmStatusCode() !== "0000") {
    // Handle errors
}

Závěrem

Všechny příklady nejdete ve složce examples. Pro připojení k datové schránce budete potřebovat login a heslo nebo testovací přístup, který lze získat na základě vyplnění tohoto formuláře.

Jakmile přístupové údaje budete mít, vytvořte config.ini (z config.ini.dist).

Odkazy

Testovací prostředí datových schránek - https://www.czebox.cz/
Ostré prostředí datových schránek - https://www.mojedatovaschranka.cz/

davidfoltyn / czech-data-box

Maintainers

Details