API
      Torna alla home page
      1. ShippyPro Help Center
      2. API

      Come integrare e usare le API di ShippyPro

      Ecco una semplice guida per aiutarti con l'integrazione delle API ShippyPro.

      Le API ShippyPro sono il modo più semplice per integrare il tuo sistema con oltre 140 Corrieri in tutto il mondo per spedire i tuoi pacchi.

       


      Sommario:

      1. Prima di iniziare
      2. API di ShippyPro
      3. Come posso testare l'API di ShippyPro?
      4. Come funziona la convalida dei campi API
      5. Errori & risoluzioni

       

      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.

        Tipo di API

        Puoi scegliere le funzionalità per le tue chiavi API da questo menu a tendina:

        image-20240716-071311

        Accesso Completo: la chiave API può essere utilizzata per tutte le funzionalità dell'API (spedizioni, recupero delle tariffe, accesso alle mappe Ship&Collect, ecc.)

        Mappe: la chiave API può essere utilizzata solo per mostrare la mappa PUDO per le funzionalità Ship&Collect

        PII Escluso: tutte le Informazioni Personali saranno oscurate da questa chiave (nomi, indirizzi, numeri di telefono, ecc.)

      Per ulteriori informazioni su come attivare la sezione API, ti invitiamo a contattare il nostro team all'indirizzo sales@shippypro.com

       

      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.

      Se ottieni l'errore “API Key cannot access PII methods”, è necessario creare una nuova chiave API da zero ed eseguire le chiamate con quella appena creata.


      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 si desidera aumentare questo limite, contattare sales@shippypro.com per un preventivo.

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

       

      Le API (Request + Response) sono in formato Json

       

       

      3. 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:

      Ricorda che le chiamate Ship e Edit genereranno etichette di spedizione REALI che verranno conteggiate come parte delle spedizioni fornite ogni mese con il vostro Piano attuale. Si consiglia di utilizzare il Corriere Generico per testare queste chiamate.


      ​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.

       

      4. 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!

      • Abilita il controllo di convalida bloccante su tutti i campi delle richieste API: Se desideri impedire l'invio della chiamata API in caso di dati mancanti o di un'API non valida, puoi selezionare questa opzione per bloccare la generazione della chiamata. In tal modo, si verificherà un errore nella richiesta.
      • NON BLOCCARE ma includi suggerimenti di convalida dei campi nelle risposte API: sarà comunque inviata la chiamata API, accompagnata da suggerimenti utili per identificare eventuali errori riscontrati.
      • NON BLOCCARE e NON INCLUDERE alcun suggerimento di convalida nelle risposte API: consente di non bloccare la chiamata e di non visualizzare alcun suggerimento per l'errore

      📌 Nota che se si utilizza la nostra Console API non sarà possibile modificare lo schema di ciascuna chiamata e la convalida predefinita sarà quella più complessa.

      📌 Per evitare che la spedizione vada comunque a buon fine nonostante ci siano dei problemi di convalida, basta abilitare l'opzione corrispondenteAbilita il controllo di convalida bloccante su tutti i campi delle richieste API. In questo modo non si genereranno etichette vuote nella risposta.

      5. Errori & Risoluzioni

       

      Visita questo link per verificare gli errori più comuni e le risoluzioni relative alle API:

      Come risolvere gli errori API