Come integrare e usare le API di ShippyPro

1. Prima di iniziare

Per iniziare a utilizzare l'API ShippyPro, è necessario innanzitutto:

1. Creare un account ShippyPro cliccando qui. Se desideri sapere come creare un account passo dopo passo, clicca qui.

2. Connettere i tuoi account Corrieri dalla sezione Corrieri. Per maggiori dettagli, leggi l’articolo Come connettere i Corrieri.

3. Dopo aver impostato il tuo profilo ShippyPro, leggi la nostra API-Documentation attentamente. Troverai tutte le informazioni necessarie per utilizzare le nostre API. 

4. Puoi decidere di attivare una Cartella Ordini API per poter gestire le tue spedizioni API direttamente dalla piattaforma, scopri qui come fare.

È possibile aggiungere più di una chiave API direttamente dal proprio profilo ShippyPro seguendo questi semplici passaggi:

• Clicca su Integrazione > API
• Clicca su Aggiungi API e la chiave API si formerà automaticamente.

2. API ShippyPro

Utilizzando la nostra soluzione API, potrai far comunicare tutti i tuoi sistemi (come OMS, WMS, POS, ERP e molti altri) con i tuoi corrieri utilizzando una semplice integrazione API.

La nostra API è scritta in 14 linguaggi di programmazione e in due diverse tecnologie, REST e SOAP.
Ogni chiamata API ha il suo metodo: secondo gli ultimi aggiornamenti, attualmente accettiamo solo il metodo POST.

Troverai la tua Chiave API cliccando su Integrazioni  > API. 

Dopo aver copiato la chiave API, segui la procedura di attivazione menzionata qui: 

Documentazione API > Authentication.

Ricorda di impostare Username e Password come segue:

• Username: La tua API KEY as Username

• Password: il campo deve essere lasciato vuoto

Quante chiamate API posso effettuare contemporaneamente?

Con ShippyPro è possibile effettuare fino a un massimo di 20 chiamate API ogni 10 secondi.
Ciò significa che è possibile effettuare 10 chiamate API in un secondo, ma poi rimarranno solo 10 chiamate API per i nove secondi successivi.

Quando l'invio di richieste supera questo limite, l'API restituirà il seguente errore: Errore: 429 Too Many Requests.

In alternativa, vi suggeriamo di utilizzare indirizzi IP diversi e di applicare una logica di bilanciamento del carico per superare questo limite.

Se avete ulteriori dubbi su questo limite, contattate i nostri team di Customer Success o di Supporto, in modo che possano aiutarvi a convalidare l'implementazione dell'API e suggerirvi come ottimizzarla!

 
Da Integrazioni >  API, fai clic su Visualizza log API per vedere le richieste e le risposte in tempo reale in modo più dettagliato.

3. ShippyPro API 

Qui di seguito le richieste API più frequenti:
​

Basic APIs:

• GET RATES

ShippyPro RATE API ti permette di ottenere le tariffe dei tuoi corrieri ordinate per prezzo con una semplice richiesta API. Saranno inclusi anche i giorni di consegna stimati.

📌 Le tariffe Corriere dipenderanno da quelle previste dal tuo contratto con lo stesso, trovi qui come poterle aggiungere al tuo profilo ShippyPro.

• SHIP

Ship ti permette di spedire i tuoi ordini e generare etichette di spedizione nel formato impostato sul profilo per qualsiasi corriere supportato.

Le Chiamate Ship e Edit genereranno etichette di spedizione REALI e scalate dalle 30 previste ogni mese. Ti consigliamo di utilizzare il Corriere Generic per testare queste chiamate.

I valori CarrierName, CarrierService e CarrierID dovranno essere ripresi da qui: 

Nota: con la stessa chiamata API Ship è possibile creare una sola spedizione alla volta.

Ricorda che se inserisci Async = true, dovrai usare un Webhook per generare un'etichetta.
​ 

• EDIT

Questo metodo offre la possibilità di modificare una spedizione precedentemente creata. La struttura del metodo è la stessa del metodo Ship API, ma il parametro OrderID deve corrispondere a un ID ordine ShippyPro esistente.

• GETTRACKING

Con questa API, puoi tracciare le tue spedizioni e ricevere notifiche ad un webhook ogni volta che la spedizione cambia stato.

• PUTORDER

Questo metodo consente di importare gli ordini da spedire all'interno di ShippyPro.

• PRINTORDER

Questo metodo consente di stampare le etichette degli ordini con una stampante collegata a ShippyPro.

• PRINTORDERBYSKU

Questo metodo consente di stampare le etichette degli ordini con una stampante collegata a ShippyPro, cercando un articolo SKU negli ordini.

Premium APIs:

• CheckAddress

• IsResidentialAddress

• BookPickup

• GetPickups

• CancelPickup

• GetPickupAvailability

• GetMarketplaces

• GetCarriers

• GetCarrierOptions

• GetCarrierPackagesTypes

• CreateManifest

• GetManifest

• DeleteManifest

• CloseShipments

• UploadPaperlessDocumentation

• GetOrder

• ArchiveOrders

• UpdateOrders

• VoidShipments

• GetLabelUrl

• GetPendingOrders

• GetShippedOrders

• DeletePendingOrder

• IsPendingOrder

• EditPendingOrders

• PutShippedOrder

• GetPOD

• GetDetailedPricing

• CreateInvoice

• MarkOrdersAsPrinted

• GetShipmentsReport

• GetReturnsReport

• CreateMasterShipment

• CloseMasterShipment

• GetPrinters

• GetDropOffPoints

Contatta il nostro Team Sales se sei interessato alle nostre Premium API!

4. Come posso testare le API di ShippyPro?

È possibile testare le nostre chiamate API da Integrazioni e API > API. Fare clic sul pulsante in alto a destra Usa la console API.

Avrai accesso alla Console API di ShippyPro, dove potrai testare tutte le nostre chiamate API:

​Tieni presente che dato che Generic non è un Corriere reale, non è possibile generare un numero di tracking valido. Scopri come usare Corriere Generico facendo click qui.

📌Se si desidera utilizzare una chiamata API che non è inclusa tra quelle elencate nella Console API, è necessario utilizzare un altro software come Postman o Insomnia.

Quindi, cosa viene effettivamente conteggiato come una chiamata API corretta?

In breve, verranno conteggiate solo le spedizioni generate attraverso la chiamata Ship, e quindi solo quelle generate correttamente. Quelle che hanno subito un errore non saranno incluse.

La chiamata Get Rates mostra semplicemente i prezzi e le opzioni per la spedizione, per questo motivo non riguarda il conteggio delle spedizioni.

Inoltre, gli ordini con errori non saranno conteggiati come spedizioni corrette.

5. Come funziona la convalida dei campi API

Puoi decidere di applicare la migliore opzione di convalida dei campi API che preferisci in ogni momento dall'account ShippyPro > Integrazioni > API:

È possibile scegliere tra tre diverse opzioni disponibili, vediamole!