EasyCargo API útmutató (1. rész)

Oldalunk böngészése közben talán találkozott már az API kifejezéssel. Ez a rövidítés szorosan kapcsolódik az IT-iparhoz, ezért nem biztos, hogy azonnal világos, mire való is szolgál, és milyen előnyöket kínál az API. Ezért döntöttünk úgy, hogy írunk egy háromrészes sorozatot az API-ról, annak működéséről, valamint arról, hogyan egyszerűsítheti le az EasyCargo-ban végzett munkáját.

Az első rész egy kicsit elméleti jellegű lesz – elmagyarázzuk az API rövidítés jelentését, és egy egyszerű példán keresztül megmutatjuk, hogyan működik a gyakorlatban. A minisorozat többi részének tartalma a cikk végén található.

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

A fenti kép nagyon egyszerűen mutatja be az API szerepét. Érdemes azonban előre megválaszolni a kérdést: Mi is az az API? Az API az Application Programming Interface (alkalmazásprogramozási interfész) rövidítése. Többféle API létezik, az EasyCargo az úgynevezett REST API-t használja. A típus jelentését itt külön nem tárgyaljuk, mivel nem olyan fontos az API-elv megértéséhez. Az alkalmazásprogramozási interfész olyan megoldások összessége, amelyekkel egy másik szolgáltatás adatait használhatja a saját weboldalán vagy szoftverében. Hogy ez mit jelent? Ha a cége rendelkezik belső (pl. szállítástervező) alkalmazással, akkor egyszerűen letöltheti az adatokat az EasyCargo számlájáról, amelyek ezután közvetlenül a céges szoftverbe kerülnek.

Az EasyCargo vagy más szoftverrel folytatott kommunikációhoz azonban API kulcsra van szükség. Ez lehetővé teszi, hogy az EasyCargo-val folytatott kommunikáció során azonosítani lehessen a weboldalt. Ha szeretne egyet szerezni, küldjön e-mailt a support@easycargo3d.com címre, vagy használja a kapcsolatfelvételi űrlapot. Miután kigenerálásra került a kulcs, megtekintheti azt a felhasználói profilban a jobb felső sarokban.

Vigyázat – a kulcsot fiókja jelszavaként kezelje, és ne ossza meg senkivel!

Ezzel elmagyaráztunk minden fontosat. Végül az ábrán látható egyszerű példán keresztül bemutatjuk, hogyan is működik pontosan az alkalmazásprogramozási felület.

Most már elvileg van elképzelése róra, hogy mi is az API és hogyan működik. Lásd még az API információkat és példákat – EasyCargo API dokumentáció. Felhívjuk szíves figyelmét, hogy a dokumentációban szereplő összes példa HTTP protokollt használ. Javasoljuk azonban a biztonságosabb HTTPS protokoll használatát.

Összefoglalva, sikeresen befejeztük az API lényegéről szóló sorozat első részét. A következő epizód ennél gyakorlatibb lesz. Bemutatjuk az EasyCargo API használatát, egyebek mellett saját API-kliensünk segítségével. Az utolsó részben megnézzük, hogy mi mindent tesz lehetővé az API kommunikációja az EasyCargo-val.