By
·
6 minute read
Ecco una semplice guida per aiutarvi con l'integrazione API per le spedizioni di ShippyPro.
L'API di ShippyPro è il modo più semplice per integrare il vostro sistema con oltre 155 corrieri in tutto il mondo e spedire i vostri pacchi. Come API multicorriere per l'ecommerce, collega gli strumenti che già usate a tutti i vostri corrieri da un'unica piattaforma di spedizione.
Punti chiave
- Prima dell'integrazione API per le spedizioni, create un account ShippyPro, collegate i vostri corrieri e verificate che il vostro piano includa l'accesso alle API.
- Potete generare più chiavi API: Full Access, Maps o PII Excluded.
- L'API accetta solo chiamate POST, in formato JSON, con un limite di 20 chiamate ogni 10 secondi.
- Testate le chiamate Ship ed Edit con il corriere Generic, perché generano etichette di spedizione reali.
- Scegliete una delle tre opzioni di validazione dei campi API per gestire i dati mancanti o non validi.
1. Prima di iniziare l'integrazione API per le spedizioni
Per iniziare a usare l'API di ShippyPro, dovete prima:
- Creare un account ShippyPro cliccando qui. Se volete sapere passo dopo passo come creare un account, cliccate qui.
- Collegare i vostri account corriere dalla pagina Corrieri e completare la configurazione del corriere. Per maggiori dettagli, leggete questo articolo qui.
- Dopo aver configurato il vostro profilo ShippyPro, leggere con attenzione la nostra documentazione API. Lì troverete tutte le informazioni necessarie per usare la nostra API.
- Potete decidere di attivare una cartella Ordini API e gestire facilmente i vostri ordini API direttamente dalla piattaforma: scoprite come farlo qui.
Requisiti del piano e app di terze parti per i punti di ritiro
Vi serve una chiave API per un'app di terze parti per i punti di ritiro? Prima di tutto, verificate che il vostro abbonamento ShippyPro includa l'accesso alla sezione API, le chiamate API e la generazione delle chiavi API.
Potete aggiornare il vostro abbonamento in autonomia dalla sezione Piani del vostro account. Per prezzi e gestione del piano, consultate Prezzi, pagamenti e piani di ShippyPro.
Ad esempio, Globe Pick Up è un'app di terze parti con un proprio listino prezzi che permette ai vostri clienti di scegliere un punto di ritiro al checkout. Ha bisogno dell'accesso alle API di ShippyPro per trasmettere a ShippyPro le informazioni sul punto di ritiro selezionato.
I costi di Globe Pick Up sono separati dal vostro abbonamento ShippyPro. Pagare Globe Pick Up non sostituisce l'abbonamento ShippyPro necessario per l'accesso alle API.
Per indicazioni sulle spedizioni verso punti di ritiro, consultate Come aggiungere un punto di consegna alle spedizioni.
Come generare la vostra chiave API
Potete aggiungere più di una chiave API direttamente dal vostro profilo ShippyPro. Seguite questi semplici passaggi:
Aprite la sezione API del vostro profilo ShippyPro.
Cliccate su "Add API" e la chiave API verrà generata automaticamente.
Tipo di API
Potete scegliere le funzionalità delle vostre chiavi API da questo menu a tendina:
| Tipo di chiave API | Cosa permette di fare |
|---|---|
| Full Access | La chiave API può essere usata per tutte le funzionalità API (spedizioni, recupero tariffe, accesso alle mappe Ship&Collect, ecc.) |
| Maps | La chiave API può essere usata solo per mostrare la mappa PUDO per le funzionalità Ship&Collect |
| PII Excluded | Tutte le informazioni personali verranno oscurate da questa chiave (nomi, indirizzi, numeri di telefono, ecc.) |
I parametri delle chiamate API distinguono tra maiuscole e minuscole e devono corrispondere esattamente alla documentazione.
2. Come funziona l'API spedizioni di ShippyPro
Con la nostra soluzione API, potete far comunicare tutti i vostri sistemi (come OMS, WMS, POS, ERP e molti altri) con i vostri corrieri tramite una semplice integrazione API.
La nostra API è disponibile in 14 linguaggi di programmazione e in due diverse tecnologie, REST e SOAP.
Ogni chiamata API ha il proprio metodo: secondo gli ultimi aggiornamenti, al momento accettiamo solo il metodo POST.
Trovate la vostra chiave API cliccando su API.
Dopo aver copiato la vostra chiave API, seguite i passaggi spiegati qui: Documentazione API > Authentication.
Se ricevete l'errore "API Key cannot access PII methods", dovete creare una nuova chiave API da zero ed eseguire le chiamate con quella appena creata.
Ricordate di impostare la chiamata API in questo modo:
- CHIAVE API come Username
- Lasciate vuota la Password
Quante chiamate API posso fare contemporaneamente?
Con ShippyPro potete effettuare fino a un massimo di 20 chiamate API ogni 10 secondi.
Questo significa che potete fare 10 chiamate API in un secondo, ma poi vi resteranno solo 10 chiamate API per i nove secondi successivi.
Quando le richieste superano questo limite, l'API restituisce il seguente errore: Error: 429 Too Many Requests.
In alternativa, vi suggeriamo di usare indirizzi IP diversi e applicare una logica di load balancer per superare questo limite.
Se volete aumentare questo limite, contattate [email protected] per un preventivo.
Dalla sezione API, cliccate su "View API logs" per vedere in dettaglio richieste e risposte in tempo reale.
Le API (richiesta + risposta) sono in formato JSON.
Prodotto e risorse
API di ShippyPro
Collegate OMS, WMS, POS o ERP ai vostri corrieri con un'unica API spedizioni.
Scoprite l'API →Integrazioni
Scoprite i corrieri, i marketplace e le piattaforme ecommerce che potete collegare.
Vedi le integrazioni →Piattaforma di spedizione
Create etichette di spedizione e gestite tutti i corrieri da un unico posto.
Scoprite la piattaforma →Documentazione API
Metodi, autenticazione e parametri per la vostra integrazione API.
Leggete la documentazione →State pianificando l'integrazione API per le spedizioni?
Prenotate una demo e scoprite come l'API di ShippyPro collega i vostri sistemi a oltre 155 corrieri.
3. Come posso testare l'API spedizioni di ShippyPro?
Potete testare la nostra API tramite la documentazione API o un software esterno che supporti le chiamate API.
Come funziona la documentazione API?
Cliccate sul pulsante in alto a destra "Use the API Console".
Verrete reindirizzati alla nostra documentazione API, dove potete testare i vari metodi API elencati nel pannello a sinistra.
Tenete presente che le chiamate Ship ed Edit generano etichette di spedizione REALI, che vengono conteggiate tra le spedizioni incluse ogni mese nel vostro piano attuale. Vi consigliamo di usare il corriere Generic per testare queste chiamate.
Per eseguire un test, selezionate il metodo che volete usare e avviate il test con il pulsante "Test request" sulla destra.
Vi verrà mostrata un'interfaccia con il metodo selezionato: basta inserire la vostra chiave API nella sezione Bearer Token e premere "Send" in alto nella schermata.
Tenete presente che, poiché Generic non è un vero corriere, non è possibile generare un numero di tracking valido. Scoprite come usare il corriere Generic cliccando qui.
Se volete usare una chiamata API non inclusa tra quelle elencate nella lista API, dovrete usare uno strumento diverso come Postman o Insomnia.
Cosa viene conteggiato come chiamata API?
In breve, vengono conteggiate solo le spedizioni generate tramite la chiamata Ship, e solo quelle generate correttamente. Quelle andate in errore non vengono incluse.
La chiamata Get Rates mostra semplicemente prezzi e opzioni per la spedizione, per questo motivo non incide sul conteggio delle spedizioni.
Inoltre, gli ordini in errore non vengono conteggiati come spedizioni.
4. Come funziona la validazione dei campi API
Potete scegliere in qualsiasi momento l'opzione di validazione dei campi API che preferite dalla sezione API.
Potete scegliere tra tre diverse opzioni, vediamole insieme!
| Opzione di validazione | Cosa succede |
|---|---|
| Enable the blocking validation control on all API requests fields | Se volete impedire l'invio della chiamata API in caso di dati mancanti o API non valida, potete selezionare questa opzione per bloccare la generazione della chiamata. La richiesta restituirà un errore. |
| DO NOT BLOCK but include fields validation suggestions in the API responses | La chiamata API viene comunque inviata, accompagnata da suggerimenti utili per individuare eventuali errori. |
| DO NOT BLOCK and DO NOT INCLUDE any validation suggestions in the API responses | Permette di non bloccare la chiamata e di non mostrare alcun suggerimento sull'errore. |
Tenete presente che, se usate la nostra API Console, non potrete modificare lo schema di ogni chiamata e la validazione predefinita sarà quella bloccante.
Se non volete che la spedizione venga creata nonostante gli errori di validazione, attivate l'opzione "Enable the blocking validation control on all API requests fields". In questo modo non genererete etichette vuote nella risposta.
5. Errori e risoluzione dei problemi
Consultate questo link per vedere gli errori più comuni delle API e come risolverli: Come risolvere gli errori API
Domande frequenti sull'API spedizioni
Cos'è un'API per le spedizioni?
Un'API per le spedizioni permette ai vostri sistemi di comunicare direttamente con i corrieri per creare spedizioni e ottenere tariffe. Con l'API di ShippyPro, il vostro OMS, WMS, POS o ERP si collega a oltre 155 corrieri con un'unica integrazione.
Quante chiamate posso fare con l'API spedizioni di ShippyPro?
Fino a 20 chiamate API ogni 10 secondi; oltre questo limite ricevete l'errore 429 Too Many Requests. Per aumentarlo, contattate [email protected] per un preventivo.
Le chiamate di test vengono conteggiate nel mio piano?
Vengono conteggiate solo le spedizioni generate correttamente con la chiamata Ship, mentre le chiamate Get Rates no. Le chiamate Ship ed Edit creano etichette reali, quindi testatele con il corriere Generic.
Articoli correlati
API logistica: 8 esempi per migliorare le spedizioni
Una panoramica delle API logistiche da conoscere quando pianificate un'integrazione.
Leggi di più →WooCommerce API: perché le spedizioni si bloccano e come risolvere
Le cause più comuni degli errori API di WooCommerce e come risolverli.
Leggi di più →Perché alla tua azienda serve un software multicorriere
I vantaggi concreti di gestire tutti i corrieri da un'unica piattaforma.
Leggi di più →Come risolvere gli errori API
Gli errori più comuni dell'API di ShippyPro e come risolverli.
Apri la guida →Pronti a collegare i vostri sistemi a oltre 155 corrieri?
Prenotate una demo e avviate la vostra integrazione API per le spedizioni con ShippyPro.
ShippyPro è il software di spedizione completo per il retail online e offline. Grazie alle funzionalità di Label Creator, Track & Trace, Easy Return e Analytics, il nostro software semplifica le tue operazioni di spedizione. ShippyPro si integra con oltre 180 Corrieri e 80 canali di vendita, rendendolo compatibile con un'ampia gamma di prodotti e casi d'uso.