Guia d’ús d’API d’EasyCargo (part 2)

Com va ser esmentat a la primera part de l’article, avui ens aproparem a l’API d’EasyCargo més per la part pràctica. Per a aquesta ocasió, utilitzarem el nostre client API. També provarem l’operació de l’API usant l’eina online ReqBin. El qual permet la comunicació amb un servidor WWW, des d’on podem descarregar dades d’interès de la nostra calculadora de càrrega als contenidors i camions EasyCargo. Provar l’API és una cosa, però a la vida real, és possible que utilitzeu un plugin de Java per al teu programari o Javascript per fer trucades des de SAP. Una altra opció pot ser la Plataforma Make, però això juntament amb altres casos d’ús d’API en casos reals ho abordarem al següent article d’aquesta sèrie.

Vegeu el resultat de la sol·licitud esmentada a l’eina ReqBin

La imatge de la part superior mostra al nostre client per utilitzar la nostra API d’EasyCargo. Per poder enviar alguna petició a l’API al nostre servidor web, el client primer ha de ser autoritzat. Per començar, la primera petició és un mètode POST http://go.easycargo3d.com/api/v1/authentication amb el username i l’API key al contingut. Rebràs un token d’autenticació com a resposta del servidor. Cada petició subseqüent (llevat que s’indiqui el contrari) de l’API ha de ser autenticada afegint el token obtingut com a header. Val la pena ressaltar aquí que totes les peticions de l’API són fetes sobre la base del token de l’usuari. Les peticions i les respostes s’han de crear en format JSON o XML.

Ara que ens hem autenticat, anem a la part més divertida de l’API. Assumim que X usuari té els següents carregaments emmagatzemats al vostre compte.

Practicarem amb les peticions a l’API a les càrregues, perquè els carregaments són probablement la part més important d’EasyCargo. Altres peticions com ara el maneig d’usuaris estan formulats d’una manera molt similar, ja que creiem que cadascun dels lectors d’aquest article serà capaç de manejar altres peticions. A la nostra documentació de l’API, cada mètode de la interfície de programació està descrit i explicat.

Si encara hi ha dubtes, poseu-vos en contacte amb nosaltres a soporte@easycargo3d.com o feu servir el nostre formulari de contacte.

Peticions a l’API de carregaments

Com que la documentació de l’API ens informa, amb peticions apropiadament redactades som capaços d’obtenir la llista de tots els carregaments des del servidor, també informació i càrregues específiques del compte d’EasyCargo. Fins i tot es pot crear o esborrar una càrrega des del compte.

Obtenir la llista de tots els carregaments

Vegeu el resultat de la sol·licitud esmentada a l’eina ReqBin

Obtenir informació sobre un carregament específic

Vegeu el resultat de la sol·licitud esmentada a l’eina ReqBin

Crear un carregament

Vegeu el resultat de la sol·licitud esmentada a l’eina ReqBin

Com podeu veure, la càrrega va ser reeixidament guardada al seu compte d’EasyCargo.

Vostès poden simplement obrir el carregament creat amb el mètode de l’API a la seva aplicació.

Esborrar un carregament

Vegeu el resultat de la sol·licitud esmentada a l’eina ReqBin

El carregament va ser correctament remogut del compte d’EasyCargo amb la petició apropiada.

Unes dades més sobre l’API

• El nombre de peticions de l’API està limitat en temps (60 peticions per hora). Les quotes es verifiquen per un marc de temps mòbil, per tant, en un període de temps determinat només és permès un nombre específic de peticions.
• Els errors són tornats per un codi d’estat HTTP comú. En la majoria dels casos, el cos de la resposta conté un missatge específic sobre el que va sortir malament.
• La calculadora de carregaments no es pot executar a través de l’API.
• El vostre client per a l’API ha de suportar l’accés i la modificació de la petició i la capçalera de la resposta i disseccionar en format JSON o XML.
• L’usuari de l’API ha d’iniciar sessió a l’aplicació d’EasyCargo perquè els càlculs dels plans de càrrega puguin ser processats.
• Alguns mètodes de l’API suporten l’ús de paràmetres opcionals. Vostés naturalment aprendran el significat de cadascun dels aspectes de l’API amb ajuda de la documentació. Podeu utilitzar aquests paràmetres, per exemple, quan s’elabora una petició per obtenir la llista de totes les càrregues. Només s’afegeixen a l’adreça de recurs després del signe “?”, separat pel caràcter “&” en la forma name=value, per exemple: http://go.easycargo3d.com/api/v1/shipments?from=2020-01-02&offset=0&limit=100.

Arribem a la conclusió en aquest article que l’API és un servei molt útil. Esperem que aquesta descripció pràctica us hagi explicat una mica més sobre la programació d’interfícies i com funciona. L’article d’avui és el segon en una sèrie sobre l’API d’EasyCargo, si encara no han vist la primera part, la podeu trobar aquí. La programació d’interfícies obre una infinitat de possibilitats. A la següent publicació, trobareu quins beneficis poden tenir usant l’API i aprenguin sobre els seus usos a la vida real.