Guide till EasyCargo API (avsnitt 2.)
Som vi sa i det första avsnittet av artikeln, idag ska vi titta närmare på EasyCargo API ur en mer praktisk synvinkel. Vi kommer att använda vår API-klient till det. Vi kommer också att testa fungerandet av API med hjälp av onlineverktyget ReqBin. Det möjliggör för kommunikationen med www-servern, tack vare detta kan vi ladda ner data är av intresse för oss från vårt program för lastningsplanering EasyCargo.
Att testa är en sak, men i det verkliga livet använder du kanske en Java-plugin för din programvara eller anropning av Javascript-funktioner från SAP. Mer om den här metoden, platformen Make och fler praktiska exempel på användande av API kommer i nästa avsnitt av den här serien.
Titta på hur den ovan angivna begäran ser ut i verktyget ReqBin
Bilden ovan visar vår API-klient för EasyCargo. För att kunna skicka vilka som helst API-begäran (krav) till webbservern, måste klienten först auktoriseras. Begäran att starta är alltså POST http://go.easycargo3d.com/api/v1/authentication med användarnamnet och API-nyckeln. Som svar får du ett autentiseringstoken från servern. Varje följande API-begäran (om inte annat anges) bör autentiseras genom att lägga till det erhållna tokenet till begärans header. Det är värt att påpeka att samtliga API-begäran utförs under namnet av den som är ägaren till tokenet. Begäran och svar måste skapas i formatet JSON eller XML.
Vi är klara med autentiseringen och nu går vi vidare till några mer intressanta trick med API. Låt oss anta att användaren X har följande lastningar sparade på sitt konto:
Vi kommer att visa API-begäran just på dem eftersom lastningar är nog den viktigaste delen av EasyCargo. På motsvarande sätt formuleras även övriga krav som hantering av användare, så vi tror att efter att du läst den här artikeln blir det lätt som en plätt att hantera liknande begäran. I API-dokumentationen för EasyCargo beskrivs och förklaras alla metoder av programmeringsgränssnittet. Tveka inte att fråga oss om du har vilka som helst frågor.
API-begäran rörande lastningar
I API-dokumentationen kan man läsa att man kan erhålla en lista över samtliga lastningar från servern med hjälp av rättformulerade begäran samt också uppgifter om en viss lastning under ett visst konto i EasyCargo. Man kan till och med skapa eller ta bort en lastning från kontot.
Att erhålla listan över samtliga lastningar
Titta på hur den ovan angivna begäran ser ut i verktyget ReqBin
Att erhålla uppgifter om en viss lastning
Titta på hur den ovan angivna begäran ser ut i verktyget ReqBin
Att skapa en lastning
Titta på hur den ovan angivna begäran ser ut i verktyget ReqBin
Som du kan se har lastningen skapats och sparats i ditt EasyCargo-konto.
Du kan sedan enkelt öppna den nyskapade lastningen i appen.
Att ta bort en lastning
Titta på hur den ovan angivna begäran ser ut i verktyget ReqBin
Lastningen har tagits bort från ditt konto genom denna begäran.
Några fler ord om API
- Antalet av dina API-begäran är tidsbegränsat (60 begäran om 1 timme). Kvoterna kontrolleras genom att flytta på tidsramen, så att det endast tillåts det fastställda antalet begäran under den angivna tidsperioden.
- API-fel skickas tillbaka med vanliga HTTP-statuskoder. I de flesta fallen innehåller svarskroppen ett konkret meddelande om vad som gick fel.
- Det går inte att kalkylera den slutliga lastningsplanen genom API. Det behövs alltid en person som loggar in i EasyCargo och trycker på knappen Lasta.
- Din klient för API-gränssnittet måste stödja åtkomst till och redigering av begärans header och svar samt analys av data i formatet JSON eller XML.
- För att kunna bearbeta kalkyleringen av den slutliga lastningsplanen måste API-användaren logga in i EasyCargo.
- Vissa API-metoder stöder användande av valbara parametrar, till exempel “from”. I dokumentationen tar du reda på vad de betyder. Dessa parametrar kan användas till exempel för begäran att erhålla listan över samtliga lastningar som begärts. Det räcker med att parametrarna skrivs in i adressen efter “?” och avskiljs med tecknet “&” i formatet namn=värde, t.ex.: http://go.easycargo3d.com/api/v1/shipments?from=2020-01-02&offset=0&limit=100.
Som du själv kan se är API en verkligen praktisk grej. Dagens artikel är den andra i serien om EasyCargo-API, här kan du läsa det första avsnittet om du inte hunnit än. I det tredje avsnittet kommer du att ta reda på vilka fördelar det finns med att använda vår API, vi kommer också att visa ett par exempel på hur det kan användas i det verkliga livet.
