Guida EasyCargo API (Volume 2)

Come abbiamo accennato nella prima parte di questo articolo, oggi daremo uno sguardo più pratico al EasyCargo API. A tale scopo utilizzeremo il nostro client API. Verrà inoltre testata l’API utilizzando lo strumento online ReqBin. Questo ci permette di comunicare con un server WWW che ci consente di scaricare i dati che ci interessano dal nostro software di pianificazione del caricamento EasyCargo.

Guardate come appare la richiesta di cui sopra nello strumento ReqBin

L’immagine qui sopra mostra il nostro API cliente di EasyCargo. Per poter inviare qualsiasi richiesta API al server Web, il cliente deve prima essere autorizzato. La richiesta di avvio è quindi un POST http://go.easycargo3d.com/api/v1/authentication con un nome utente e una chiave API. In risposta si riceverà un token di autenticazione dal server. Ogni richiesta API successiva (se non diversamente specificato) deve essere autenticata aggiungendo il token ricevuto nella sua intestazione. Vale la pena notare che tutte le richieste API vengono effettuate per conto del proprietario del token. Le richieste e le risposte devono essere effettuate in formato JSON o XML.

Dopo aver eseguito l’autenticazione, passiamo finalmente alla parte più interessante dell’API. Supponiamo che l’utente X abbia i seguenti caricamenti memorizzati nel suo conto:

Dimostreremo le richieste API su di essi, poiché i caricamenti sono probabilmente la parte più importante di EasyCargo. Altre richieste come la gestione degli utenti sono formulate in modo simile, quindi speriamo che dopo aver letto questo articolo possiate gestire le richieste simili con facilità. Nella dokumentazione API di EasyCargo è descritto e spiegato ogni metodo dell’interfaccia di programmazione. Se avete domande, chiedeteci pure.

Richieste API sui caricamenti

Nella documentazione API possiamo leggere che con richieste formulate in modo appropriato possiamo anche ottenere un elenco di tutti i caricamenti dal server nonché i dettagli di un caricamento specifico sotto uno specifico account in EasyCargo. Possiamo anche creare o rimuovere un caricamento dall’account.

Ottenere un elenco di tutti i caricamenti

Guardate come appare la richiesta di cui sopra nello strumento ReqBin

Ottenere informazioni su un caricamento specifico

Guardate come appare la richiesta di cui sopra nello strumento ReqBin

Creazione di un caricamento

Guardate come appare la richiesta di cui sopra nello strumento ReqBin

Come potete vedere, il caricamento è stato creato e salvato con successo nel vostro account EasyCargo.

È quindi possibile aprire semplicemente il caricamento appena creato nell’applicazione.

Cancellazione di un caricamento

Guardate come appare la richiesta di cui sopra nello strumento ReqBin

Il caricamento è stato rimosso dal vostro account con la richiesta appropriata.

Qualche parola in più sulľAPI

• Il numero di richieste API è limitato nel tempo (60 richieste ogni 1 ora). Le quote vengono controllate spostando l’intervallo di tempo, quindi in un determinato periodo di tempo è consentito solo il numero di richieste specificato.
• Gli errori API vengono inviati indietro tramite i comuni codici di stato HTTP. Nella maggior parte dei casi, il corpo della risposta contiene un messaggio specifico su cosa è andato storto.
• Tramite l’API non può essere effettuato il calcolo del piano di carico risultante. Sempre una persona deve effettuare il login in EasyCargo e premere il pulsante Caricare.
• Il vostro cliente dell’interfaccia API deve supportare l’accesso e la modifica dell’intestazione della richiesta e della risposta e l’analisi dei dati in formato JSON o XML.
• L’utente API deve essere loggato in EasyCargo per poter elaborare il calcolo del piano di carico risultante.
• Alcuni metodi API supportano l’uso di parametri opzionali come ad esempio “from”. Per conoscere il significato di ciascuno di essi, consultare la documentazione. Questi parametri possono essere utilizzati, ad esempio per richiedere un elenco di tutti i caricamenti richiesti. Basta aggiungere i parametri all’indirizzo dopo il “?” separato dal carattere “&” nella forma name=value, ad esempio: http://go.easycargo3d.com/api/v1/shipments?from=2020-01-02&offset=0&limit=100.

Come potete vedere l’API è un servizio davvero utile. L’articolo di oggi è il secondo di una serie sull’API di EasyCargo quindi se non avete ancora letto la prima parte, potete trovarla qui. Nel prossimo articolo scoprirete i vantaggi dell’utilizzo della nostra API e vi mostreremo alcuni casi d’uso reali.