Documentazione API

Argomento: Tutto quello che devi sapere sull'integrazione del tuo negozio online personalizzato con Sendcloud tramite la nostra API (RESTful). 

I piani di Sendcloud sono stati aggiornati. Se gli abbonamenti mostrati nel banner qui sopra non corrispondono al tuo attuale piano e vuoi saperne di più, clicca qui.

Link correlati

• Guida di riferimento alle API di Sendcloud
• Portale per gli sviluppatori di Sendcloud
• Punti di ritiro (service points) per le integrazioni API
• Domande frequenti sulle API di Sendcloud

Sendcloud offre funzionalità e tool che aiutano i negozi online ad automatizzare il processo di spedizione. Le nostre funzionalità completamente scalabili semplificano la vita dei venditori online, sia che si tratti di una ditta individuale o di una start-up o di una grande azienda che spedisce migliaia di pacchi al mese in tutto il mondo. 

Integrazione con Sendcloud

Ci sono due modi per collegare un negozio online a Sendcloud:

Integrazioni plug and play

Se utilizzi un sistema di e-commerce come Shopify, WooCommerce, Lightspeed o Magento, non hai bisogno di competenze di sviluppo web per collegare il tuo negozio. Forniamo applicazioni e plug-in plug and play per oltre 80 tra le piattaforme di e-commerce più popolari. Puoi scaricarli dal marketplace o dall'app-store del tuo sistema.

API di Sendcloud

Se hai un negozio web personalizzato che non è ospitato o creato tramite una piattaforma di e-commerce, è qui che entrano in gioco le nostre API. Un'API consente agli sviluppatori di connettersi e di estrarre i componenti chiave dal nostro sistema interno e di integrarli con il tuo webshop o sistema. Le API di Sendcloud sono progettate per coprire tutte le fasi della spedizione di un pacco.

Le nostre funzionalità possono essere utilizzate insieme o separatamente per darti la flessibilità di progettare e costruire il tuo flusso di lavoro dall'inizio alla fine. Le nostre API ti permettono di accedere a una vasta gamma di metodi di spedizione nazionali e internazionali dei corrieri commerciali e postali europei più usati. 

Documentazione e guida di riferimento API

Se sei uno sviluppatore esperto e vuoi iniziare rapidamente a utilizzare le nostre API, puoi consultare la nostra Guida di riferimento o accedere alle nostre Raccolte Postman.

Se non conosci le API e vuoi una spiegazione approfondita di come potrebbe essere il tuo flusso di lavoro per l'elaborazione degli ordini, dai un'occhiata alla nostra Documentazione API. Ci sono guide e tutorial per guidarti attraverso le nozioni di base, dalla creazione della tua prima spedizione con l'API alla creazione di spedizioni multicollo e al confronto delle tariffe di spedizione. 

Cosa si può fare con le nostre API?

• Shipping API
  L'API di spedizione ti dà accesso alle funzionalità principali della nostra piattaforma. Crea etichette, genera documenti doganali per le tue spedizioni internazionali e automatizza l'elaborazione degli ordini con le nostre regole di spedizione.
• Service Points API
  Integra un selettore di punti di servizio nel tuo checkout, accedi a un database di tutti i punti di servizio disponibili per dei corrieri di tutto il mondo e permetti ai tuoi clienti di scegliere il luogo più comodo per la consegna del loro pacco.
• Shipping Products API
  Confronta le tariffe, i livelli di servizio e i servizi a valore aggiunto di oltre 50 corrieri nazionali e internazionali.
• Return Portal API
  Fai in modo che i tuoi clienti gestiscano i propri resi grazie alla tua versione personalizzata del portale dei resi di Sendcloud. Utilizzala insieme alla nostra funzionalità di reso a pagamento per addebitare in modo proattivo ai tuoi clienti una tassa di reso.
• Tracking API
  Recupera l'intera cronologia di tracciamento di un pacco, dal momento in cui si crea l'etichetta di spedizione fino al momento esatto in cui arriva davanti alla porta del tuo cliente.
• Pickups API
  Pianifica un ritiro una tantum con un corriere tramite l'API Pickups e fai ritirare i tuoi pacchi dal tuo magazzino o negozio a un orario specifico.
• Dynamic Checkout API
  Aumenta i tassi di conversione grazie alla possibilità di offrire consegne il giorno successivo, in giornata in un giorno prestabilito direttamente dal tuo checkout. Configura i metodi di spedizione per zona di consegna direttamente da  Sendcloud, recupera i metodi di spedizione applicabili e presentali ai tuoi clienti nel tuo checkout grazie alla nostra API.  
• Returns API V3
  Crea resi separati per i pacchi tramite l'API dei resi (versione 3) in pochi minuti, anche se hai creato l'etichetta di spedizione originale al di fuori di Sendcloud. Accedi a un database di metodi di reso e convalida la tua richiesta di reso prima di creare l'etichetta, in modo da evitare sovrattasse indesiderate se il reso non è possibile con il metodo di reso selezionato.

Che cosa è un'API?

"API" è l'acronimo di Application Programming Interface. Un'API permette alle applicazioni di comunicare tra loro sul web. Per recuperare i dati da un'API, si fa una "richiesta" in un linguaggio di formattazione come JSON o XML, o in un linguaggio di programmazione come Python, e il server fornisce i dati richiesti in una "risposta". Le API non sono solo un database: oltre a richiedere i dati, puoi aggiornarli, crearli e cancellarli facendo richieste API a endpoint specifici.

Ad esempio, l'API di spedizione di Sendcloud ti dà accesso all'endpoint "Crea una spedizione".  Puoi fare una richiesta a questo endpoint per creare un pacco nel sistema Sendcloud fornendo all'endpoint le informazioni necessarie (indirizzo, metodo di spedizione, ecc.). Per fare una richiesta, devi sapere quali informazioni servono al nostro server per creare il pacco.

Nella nostra Guida di riferimento ti forniamo esempi di richieste e risposte, oltre a un elenco di campi obbligatori e opzionali che puoi utilizzare.

Perché utilizzare l'API invece di un'integrazione plug and play?

Gli sviluppatori web utilizzano le API per incorporare funzionalità specifiche nel negozio web o nel sistema che hanno costruito su misura. La connessione a Sendcloud tramite API ti permette di personalizzare le nostre funzionalità per soddisfare le tue esigenze aziendali, oltre a poterle integrare con altre app relative alla fatturazione e alla gestione del magazzino. 

Quando si fa l'integrazione con Sendcloud tramite API, si ha la piena flessibilità di decidere come costruire il flusso di lavoro per l'elaborazione degli ordini e la logistica. Puoi scegliere di elaborare i tuoi ordini direttamente tramite l'API, oppure importare gli ordini nella dashboard di Sendcloud ed elaborarli da lì. Dal momento che la nostra API ti dà accesso alle nostre funzioni chiave individualmente, puoi decidere quali funzioni sfruttare e incorporarle direttamente nel tuo sistema e nel tuo flusso di lavoro. 

Come iniziare

Sei pronto per cominciare l'integrazione con le API di Sendcloud? Prima di iniziare, assicurati di aver creato un account Sendcloud e di aver seguito i passaggi della Guida rapida all'uso di Sendcloud. 

Affinché la nostra API accetti le tue richieste prima devi fare le seguenti operazioni:

1. Imposta gli indirizzi del mittente e del destinatario (facoltativo)
2. Attiva i corrieri nel tuo account
3. Imposta il tuo metodo di pagamento (necessario per poter creare le etichette di spedizione). Maggiori informazioni su come Sendcloud addebita le etichette di spedizione qui.

Opzionale: non dimenticare di creare il tuo brand, di attivare le notifiche di tracking e di impostare il portale dei resi.

Autenticazione

Sendcloud utilizza l'autenticazione di base (Basic Access Authentication) per autenticare le richieste alle nostre API. Dovrai includere una chiave API pubblica e una privata nell'intestazione di ogni richiesta fatta a un endpoint Sendcloud.

Esempio: 

curl “https://app.sendcloud.sc/api/v2/parcels” --user “YOUR_API_KEY:YOUR_API_SECRET”

Per ulteriori esempi di autenticazione con le nostre API, vedi la sezione Autenticazione del nostro portale per gli sviluppatori.

Come ottenere le chiavi API

1. Accedi al tuo account Sendcloud e vai su Impostazioni > Integrazioni
2. Cerca l'API di Sendcloud nell'elenco delle integrazioni e clicca su Connetti.
3. Scegli un nome per la tua integrazione API (ad esempio: Il mio negozio online) e clicca su Salva.
4. Le tue chiavi API pubbliche e segrete saranno generate automaticamente. Copiali in un posto sicuro e includili nelle intestazioni delle tue richieste. La chiave pubblica è il tuo "nome utente" quando ti autentichi con l'API, mentre la chiave segreta (privata) funge da "password". 

Attivare i service point (punti di ritiro)

Nella pagina delle impostazioni di integrazione, come descritto sopra nella sezione Autenticazione, puoi scegliere di attivare o disattivare i service point. Se vuoi effettuare richieste Service Point API per inviare i pacchi a un punto di ritiro o per visualizzare il selettore dei punti di ritiro disponibili nel tuo checkout web, attiva i service point.

Una volta selezionata la casella per abilitare i service point, puoi selezionare i corrieri che vuoi includere come metodi di consegna per i punti di servizio e cliccare su Salva. 

Creare etichette di prova

Puoi provare la nostra API senza preoccuparti dei costi grazie al metodo di consegna "Unstamped Letter". Per maggiori informazioni sulla creazione di etichette di prova tramite l'API, leggi la nostra documentazione.

Domande frequenti (FAQ)

Se hai domande sull'utilizzo delle nostre API, puoi consultare la nostra Guida FAQ sulle integrazioni API. 

Indirizzi IP da includere nella lista bianca