Ne všichni děláme integrace každý den. Proto jsme pro vás připravili rychlokurz integrace v dnešním světě, kde stručně zmiňujeme ty nejdůležitější pojmy a nástroje pro integraci s využitím tzv. REST API.
Základní principy a pojmy
Co potřebuje mít člověk v hlavě, aby rozuměl věcem kolem API:
Komunikace po internetu https://everything.curl.dev/protocols/network
Internetové protokoly https://everything.curl.dev/protocols/protocols
EndPoint - https://en.wikipedia.org/wiki/Web_API
Základní princip volání REST API - pří i volání se přes internetový HTTP protokol pošle požadavek - HTTP Request, zpátky volající obdrží opět přes HTTP protokol odpověď HTTP Response.
Postman
Postman je služba, která umožňuje ve velmi přátelském, srozumitelném prostředí textovat volání REST API rozhraní. Jednoduše si můžete organizovat různá volání, u každého volání přehledně zadáváte adresu, typ volání, head, autorizaci, body, vidíte i výsledky volání. Využívá ji i Signi na https://signiapi.postman.co/.
Volání
Pro každé volání volíte:
V záhlaví požadavku se volí typ HTTP Request, typicky GET nebo POST.
V záhlaví požadavku se také uvádí adresa endpointu je v případě Signi API má např. endpoind pro odeslání souboru k podpisu https://api.signi.com/api/v1/contract/.
V případech, kdy enpoind má parametry, zadávají se na záložce Param, V případě Signi API např. endpoint založení souboru má parametr Type s hodnotou "doc" tj. výsledná adresa je volání je https://api.signi.com/api/v1/contract/?type=doc.
Na záložce Autorization je jako typ autorizace zvolen jako typ autorizace API Key a jako hodnota klíče x-api-key je uveden API klíč workspace a umístění API klíče je zvoleno Header. API klíč pro váš workspace v Signi si vygenerujete dle návodu Generování API klíče.
Na záložce Body je jako typ volání zvoleno multipart/form-data a jsou uvedeny jeden či více Keys, což které mohou být buď typu text nebo file. V případě endpointu pro odeslání souboru k podpisu se předpokládají minimálně dva, data a uploaded_file_key. Pozor, oba dva jsou typu file, aby se do HTTP požadavku opravdu fyzicky přenesli soubory. V prvním je JSON s parametry volání endpointu, v druhém je soubor k podpisu - PDF anebo DOC, DOCX, XLS, XLSX, HTML. U každého klíče je třeba zvolit typ parametru je File, Klepnutím na “Select Files” se otevře výběr souboru, vložíte příslušný.
Tlačítkem Send se odesílá požadavek na příslušné REST API. V dolním panelu pro zobrazení výsledku se ukazuje výsledek volání tj. obsah HTTP Response.
Tlačítkem Save se ukládá požadavek do Postmana pro opakované použití.
Záložka param
Záložka Autorization
Záložka Body
Klíče na záložce Body jsou typu “File”, soubor k zaslání v požadavku se vybere z vašeho disku a nahraje přes “Select Files”.
Výsledek
Po odeslání požadavku tlačítkem Send se zobrazí v dolním panelu výsledku se ukazuje výsledek volání endpointu daného REST API. tj. obsah HTTP Response.
V případě úspěchu se objevuje kód 200 s příslušným komentářem. V případě chyby typicky kód 4xx nebo 5xx. Pi volání Signi API jsou nejčastější tyto chyby.
Výsledek volání endpointu.
Curl
Pokud jste spíše příznivcem příkazového řádku, mohl by vám vyhovovat pro účely testování volání REST API rozhraní Curl. Curl je open source program pro přenos dat přes různé internetové protokoly. Jeho příkazy se používají k popisu toho, jak se jaká data se při integraci přenáší. Stejně tak lze příkazy v programu spustit.
HTTP POST https://everything.curl.dev/http/post
HTTP Multipart formposts https://everything.curl.dev/http/multipart
HTTP cheat sheet - https://everything.curl.dev/http/cheatsheet
Seznam všech příkazů - https://curl.se/docs/manpage.html
Curl je většinou již součástí operačního systému - např. MS Windows, kde se spouští z aplikace Příkazová řádka, jež se spouští vyhledáním “cmd” ve vyhledávacím poli na pracovní ploše.
Curl příkaz spuštěný z příkazové řádky na MS Windows a jeho výsledek
Příklady volání Signi API
Až se prokousáte základy REST API, můžete pokračovat na příklady volání API anebo Pokročilé příklady volání Signi API. Pokud ještě tápete, napište nám na help@signi.com.
Byl tento článek užitečný?
To je skvělé!
Děkujeme Vám za zpětnou vazbu
Je ním líto, že jsme vám nepomohli
Děkujeme Vám za zpětnou vazbu
Zpětná vazba odeslána
Oceňujeme vaši snahu a pokusíme se článek opravit