Při procházení našich stránek jste možná narazili na pojem API. Tato zkratka úzce souvisí s IT odvětvím, takže nemusí být hned jasné, k čemu API slouží a jaké má výhody. Proto jsme se rozhodli sepsat třídílnou sérii právě na téma API, jak funguje a jak vám může zjednodušit práci v EasyCargu.

První část bude trochu teoretická – vysvětlíme si význam zkratky API a na jednoduchém příkladě si ukážeme, jak funguje v praxi. Obsah dalších dílů této minisérie naleznete na konci článku.

 

Role API

Zdroj: https://bykowski.pl/wp-content/uploads/2021/06/api-przyklad-dzialania-1.jpg

 

Obrázek výše ukazuje velmi jednoduchým způsobem roli API. Nicméně stojí za to si předem odpovědět na otázku: Co to vlastně API je? API je zkratkou pro Application Programming Interface, česky rozhraní pro programování aplikací. Existuje několik druhů API, EasyCargo používá takzvanou REST API. Význam tohoto druhu zde nebudeme probírat, jelikož není pro pochopení principu API zas tak důležitý.

Rozhraní pro programování aplikací je soubor řešení, pomocí kterých můžete využívat data jiné služby na svém vlastním webu či v softwaru. Co to znamená? Pokud má vaše společnost interní aplikaci (např. pro plánování přepravy), můžete si ze svého účtu v EasyCargu jednoduše stáhnout data, která budou následně dodána přímo do firemního softwaru.

 

API klíč v EasyCargu - software pro plánování nakládky

Pro komunikaci s EasyCargem nebo jiným softwarem však potřebujete API klíč. Ten umožňuje identifikaci vašeho webu při komunikaci s EasyCargem. Pro jeho získání nám buďto napište na podpora@easycargo3d.com nebo použijte kontaktní formulář. Jakmile je klíč vygenerován, můžete si jej zobrazit ve svém uživatelském profilu v pravém horním rohu.

Pozor – s klíčem zacházejte jako s heslem k účtu a nikomu ho nesdělujte!

Tímto jsme si vše důležité již vysvětlili. Na závěr si ještě na jednoduchém příkladě na obrázku uvedeme, jak přesně rozhraní pro programování aplikací funguje.

 

Jak funguje API

Nyní byste již měli mít představu o tom, co to API je a jak funguje. Koukněte i na API info a příkladydokumentaci k EasyCargo API. Jen prosím pozor na skutečnost, že všechny příklady v dokumentaci jsou napsány pomocí protokolu HTTP. Doporučujeme však používat bezpečnější protokol HTTPS.

 

Dokumentace API pro EasyCargo software pro plánování nakládky

Shrnuto a podtrženo, první díl série o podstatě API máme úspěšně za sebou. Příští díl bude více praktický. Seznámíme vás s používáním API pro EasyCargo, mimo jiné pomocí našeho API klienta. V posledním díle se zaměříme na to, co vše umožňuje komunikace API s EasyCargem.

21. Bře 2022