EasyCargo API -opas (osa 1.)
Sivujamme selatessasi olet varmaan huomannut käsitteen API. Tämä lyhenne liittyy läheisesti IT-alaan, eikä lukijalle ole välttämättä heti selvää, mihin API:a käytetään ja mitä etuja sillä on. Siksi laadimme kolmiosaisen API:a koskevan sarjan sen toiminnasta ja siitä, miten se voi helpottaa EasyCargon käyttöä. Ensimmäinen osa on vähän teoreettinen – selitämme lyhenteen API merkityksen ja näytämme yksinkertaisessa esimerkissä, miten se toimii käytännössä. Tämän minisarjan muiden osien sisältö on esitetty artikkelin lopussa.
Lähde: https://bykowski.pl/wp-content/uploads/2021/06/api-przyklad-dzialania-1.jpg
Edellä olevassa kuvassa on API:n rooli esitetty hyvin yksinkertaisesti. On kuitenkin hyvä selvittää ensin kysymys: Mikä API oikeastaan on? API on lyhenne sanoista Application Programming Interface, suomeksi ohjelmointirajapinta. On olemassa erilaisia API-rajapintoja, EasyCargon käytössä on ns. REST API. Tämän tyypin merkitystä emme tässä käsittele tarkemmin, sillä se ei ole kovin tärkeää API:n periaatteen ymmärtämiselle. Ohjelmointirajapinta on sarja ratkaisuja, joiden avulla voidaan käyttää muusta palvelusta saatavaa dataa omassa sivustossa tai ohjelmistossa. Mitä tämä tarkoittaa? Jos yrityksesi käytössä on sisäinen sovellus (esim. kuljetusten suunnitteluun), voit yksinkertaisesti ladata EasyCargo-tililtäsi dataa, joka toimitetaan suoraan yritysohjelmistoon.
EasyCargon tai muun ohjelmiston kanssa kommunikointiin API:n kautta tarvitaan kuitenkin API-avain. Se mahdollistaa sivustonne tunnistuksen kommunikoinnissa EasyCargon kanssa. Sen saamiseksi joko kirjoita meille osoitteeseen support@easycargo3d.com tai käytä yhteydenottolomaketta. Heti avaimen generoinnin jälkeen löydät sen käyttäjäprofiilisi oikeasta yläkulmasta.
Huom. – käsittele avainta kuin tilisi salasanaa, älä kerro sitä kenellekään!
Kaikki tärkeä on nyt selitetty ja lopuksi voimme vielä esittää yksinkertaisen esimerkin avulla, miten ohjelmointirajapinta käytännössä toimii.
Nyt sinulla pitäisi olla käsitys siitä, mitä API tarkoittaa ja miten se toimii. Katso myös API-infoa ja esimerkkejä – EasyCargo API:n dokumentaatiota. Mutta ota huomioon, että kaikki dokumentaatiossa esitetyt esimerkit on kirjoitettu HTTP-protokollan avulla. Suosittelemme kuitenkin turvallisemman HTTPS-protokollan käyttöä.
Ja nyt vain yhteenvetona, että API:a koskevan sarjan ensimmäinen osa on käyty läpi. Seuraava osa on käytännöllisempi. Tutustutamme sinut API:n käyttöön EasyCargon kanssa muun muassa API-asiakasohjelmamme avulla. Viimeisessä osassa selitämme, mitä kaikkea API:n ja EasyCargon välinen kommunikaatio mahdollistaa.
