Download the PHP package malcanek/idoklad without Composer
On this page you can find all versions of the php package malcanek/idoklad. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download malcanek/idoklad
More information about malcanek/idoklad
Files in malcanek/idoklad
Package idoklad
Short Description PHP třída pro ulehčení požadavků na iDoklad api v1.
License MIT
Homepage https://github.com/malcanek/iDoklad
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package idoklad
Tato knihovna již není dále vyvíjena a nebude podporována ani ze strany iDokladu. iDoklad nyní používá api v2, ke kterému můžete naleznout php knihovnu na malcanek/iDoklad-v2
iDoklad
PHP třída pro ulehčení požadavků na iDoklad api v1.
Získání tokenu a následná autorizace požadavků
Pro zadání prostředí, které je vyžadováno v hlavičkách iDokladu slouží funkce setEnviroment(XApp, Version, Token). Při získávání tokenu se zavolá bez proměnné token:
Pokud již známe token, volá se funkce takto:
Pro získání tokenu slouží funkce getToken(email, heslo). Pokud se nepodaří token získat, nebo nejsou zadané parametry s názvem aplikace a její verzí, vyhodí funkce výjimku (Exception). Ta má ve zprávě buď 'Zadejte nazev aplikace a jeji verzi' (= zavolejte funkci setEnviroment, nebo obsahuje chybu z api (např. špatné jméno a heslo). Pokud proběhne získání úspěšně, uloží token do třídy a zároveň ho vrátí pro další zpracování (např. uložení do db).
Třída iDoklad
Tato třída slouží k obsluhování api pomocí funkcí v ní vytvořených. Každá funkce je zdokumentována ohledně proměnných + obsahuje odkaz na dokumentaci api, aby bylo jasné, jaké parametry je třeba zadávat. U funkcí pro získávání PDF je třeba zadat adresu, kam se má PDF uložit.
Může se stát, že některé funkce nebudou fungovat správně, nebo tak jak by měly. Pokud tomu tak bude, můžete mne kontaktovat a pokusím se je opravit.
Třída iDokladMini
Zjednodušená třída pro přístup k api. Obsahuje pouze funkci na získání tokenu, nastavení prostředí a následné zavolání do api. Volání do api lze provádět na libolné adresy, prefix api není nutné používat. Pro dotaz do api se volá funkce curlData(adresa, parametry GET, hlavička, parametry POST).
Adresa je odkaz do api (např. IssuedInvoices) Parametry GET jsou parametry, které se posílají api (např. filtry). Vkládá se sem celé pole (array). Výchozí hodnota je prázdné pole. Hlavička je hlavička značící typ dotazu, povolené jsou GET (výchozí), POST, PUT, DELETE. Parametry POST jsou parametry určené POST a PUT příkazy. Výchozí hodnota je prázdné pole.
Příklady GET dotazu
Příklad POST dotazu
Příklad PUT dotazu
Příkald DELETE dotazu
Třída automaticky nekontroluje zadaný token!
Třída obsahuje funkci na uložení PDF v případě jeho stažení. Tato funkce se volá base64toPDF(pdf, path). Jako první parametr se zadá base64 pdf řetězec. Jako druhý parametr se zadává adresa, kam se má PDF uložit.
iDoklad
PHP třída pro ulehčení požadavků na iDoklad api.
Získání tokenu a následná autorizace požadavků
Pro zadání prostředí, které je vyžadováno v hlavičkách iDokladu slouží funkce setEnviroment(XApp, Version, Token). Při získávání tokenu se zavolá bez proměnné token:
Pokud již známe token, volá se funkce takto:
Pro získání tokenu slouží funkce getToken(email, heslo). Pokud se nepodaří token získat, nebo nejsou zadané parametry s názvem aplikace a její verzí, vyhodí funkce výjimku (Exception). Ta má ve zprávě buď 'Zadejte nazev aplikace a jeji verzi' (= zavolejte funkci setEnviroment, nebo obsahuje chybu z api (např. špatné jméno a heslo). Pokud proběhne získání úspěšně, uloží token do třídy a zároveň ho vrátí pro další zpracování (např. uložení do db).
Třída iDoklad
Tato třída slouží k obsluhování api pomocí funkcí v ní vytvořených. Každá funkce je zdokumentována ohledně proměnných + obsahuje odkaz na dokumentaci api, aby bylo jasné, jaké parametry je třeba zadávat. U funkcí pro získávání PDF je třeba zadat adresu, kam se má PDF uložit.
Může se stát, že některé funkce nebudou fungovat správně, nebo tak jak by měly. Pokud tomu tak bude, můžete mne kontaktovat a pokusím se je opravit.
Třída iDokladMini
Zjednodušená třída pro přístup k api. Obsahuje pouze funkci na získání tokenu, nastavení prostředí a následné zavolání do api. Volání do api lze provádět na libolné adresy, prefix api není nutné používat. Pro dotaz do api se volá funkce curlData(adresa, parametry GET, hlavička, parametry POST).
Adresa je odkaz do api (např. IssuedInvoices) Parametry GET jsou parametry, které se posílají api (např. filtry). Vkládá se sem celé pole (array). Výchozí hodnota je prázdné pole. Hlavička je hlavička značící typ dotazu, povolené jsou GET (výchozí), POST, PUT, DELETE. Parametry POST jsou parametry určené POST a PUT příkazy. Výchozí hodnota je prázdné pole.
Příklady GET dotazu
Příklad POST dotazu
Příklad PUT dotazu
Příkald DELETE dotazu
Třída automaticky nekontroluje zadaný token!
Třída obsahuje funkci na uložení PDF v případě jeho stažení. Tato funkce se volá base64toPDF(pdf, path). Jako první parametr se zadá base64 pdf řetězec. Jako druhý parametr se zadává adresa, kam se má PDF uložit.
