Guide till EasyCargo API (avsnitt 1)
Du kanske märkt förkortningen API när du utforskar vår webbplats. Förkortningen hänger tätt samman med IT-branschen, därför är det kanske inte genast klart vad API tjänar till och vilka fördelar som finns med det. Vi har därför bestämt oss att skriva en serie i tre avsnitt som tar upp just temat API, hur det fungerar och hur det kan underlätta ditt arbete i EasyCargo. Det första avsnittet kommer att vara lite teoretiskt – vi förklarar betydelsen av förkortningen API och på ett enkelt exempel visar hur det fungerar i praktiken. Innehållet i nästa avsnitt i serien hittar du längts ner i artikeln.
Källa: https://bykowski.pl/wp-content/uploads/2021/06/api-przyklad-dzialania-1.jpg
Bilden ovan visar på ett mycket enkelt sätt vad som är API:s roll. Det är dock värt att först svara på frågan: Vad är egentligen API? API är en förkortning av Application Programming Interface, applikationsprogrammeringsgränssnitt på svenska. Det finns flera olika typer av API, EasyCargo använder sig av det så kallade REST API. Betydelsen av den här typen diskuteras inte här eftersom den är inte så viktigt för att förstå principen med API. Ett applikationsprogrammeringsgränssnitt är en komplex av lösningar som gör att du kan använda sig av data från en annan tjänst på din egen webbplats eller programvara. Ved betyder det? Om ditt företag har en intern app (t. ex. för planering av transporter), kan du från ditt konto i EasyCargo enkelt ladda ner data som sedan skickas direkt till företagets programvara.
För att kommunicera med EasyCargo eller en annan programvara behöver du dock ha en API-nyckel. Den möjliggör för att identifiera din webbplats när den kommunicerar med EasyCargo. Skriv till oss till support@easycargo3d.com eller använd kontaktformuläret för att få nyckeln. Du kan visa nyckeln i din användarprofil högst upp till höger när den genererats.
Observera – behandla nyckeln på samma sätt som lösenordet till kontot och ge den inte till någon!
Härmed har vi förklarat allt som är viktigt. Låt oss slutligen visa en bild med ett enkelt exempel på hur exakt applikationsprogrammeringsgränssnittet fungerar.
Nu bör du redan ha en uppfattning om vad som är API och hur det fungerar. Titta även på API – information och exempel – dokumentation till EasyCargo API. Observera dock att samtliga exempel i dokumentationen är skrivna med hjälp av HTTP-protokollet. Vi rekommenderar dock att använda det säkrare HTTPS-protokollet.
Kort och koncist, vi har lyckats att ta oss igenom det första avsnittet i serien som handlade om principen med API. Nästa avsnitt kommer att vara mer praktiskt. Vi visar dig hur man använder API för EasyCargo, bland annat med hjälp av vår API-klient. I det sista avsnittet tar vi upp allt som möjliggör för kommunikationen mellan API och EasyCargo.
