API e integrazione con l'ERP
Come DGAssistant si inserisce nel suo ERP, nel sistema di magazzino o nella piattaforma di spedizione.
Serve un modulo specifico per utilizzare l'API?
Sì, l'API è un modulo con licenza separata che si aggiunge alle licenze standard. Lo aggiunge al suo abbonamento quando decide di integrare.
Come viene misurata e tariffata la fruizione dell'API?
L'API è misurata per licenza: ciascuna copre 1 500 spedizioni e 7 500 chiamate di servizio all'anno e consente alla banca dati di contenere fino a 5 000 oggetti diversi dalle spedizioni, quali merci e soggetti coinvolti (destinatari, fornitori, conducenti e gli altri). Se prevede volumi superiori è sufficiente aggiungere altre licenze. Il prezzo unitario esatto del modulo API è indicato accanto al resto del catalogo nel nostro negozio e può essere incluso in qualsiasi preventivo personalizzato.
Quali sono i due modi di utilizzare l'API: batch o interattivo?
La modalità batch riceve la descrizione completa della spedizione in un'unica chiamata di servizio — ideale quando l'ERP conosce già merci, soggetti coinvolti e quantità. La modalità interattiva consente di costruire la spedizione passo dopo passo, validando ciascuna merce man mano che viene aggiunta; è più vicina al funzionamento dell'applicazione web ed è utile quando occorre realizzare percorsi guidati dall'utente al di sopra dell'API.
Conviene creare merci e soggetti coinvolti in anticipo oppure trasmetterli al momento?
Entrambe le vie sono supportate. L'approccio consigliato è quello dei «dati predefiniti»: crei una sola volta merci e soggetti nell'applicazione web (o li importi) e li richiami per codice dalle chiamate all'API. L'approccio al momento consente di trasmettere tutto in ciascuna chiamata, il che è comodo quando l'ERP è il riferimento di tali dati e non desidera precaricarli.
Come recupero i PDF generati tramite l'API?
Vi sono due possibilità. Può ricevere i documenti nella risposta dell'API come PDF codificati in base64 (documento di trasporto, dichiarazione dello speditore, lista di controllo, marcatura dei colli, ecc.), oppure fare in modo che la piattaforma li invii da sé per posta elettronica a un indirizzo configurato.
Posso stampare automaticamente i documenti generati dall'API?
Sì. Due schemi funzionano bene: (a) il suo ERP scarica il PDF dall'API e lo invia alla propria coda di stampa; (b) DGAssistant invia i documenti a una casella dedicata e una piccola utilità di stampa automatica, dalla sua parte, li stampa sulla stampante corretta. Molti clienti scelgono la via della posta elettronica perché non richiede codice aggiuntivo sul lato ERP.
Dove si trova la specifica dell'API?
La specifica OpenAPI completa, con esempi interattivi, è pubblicata nella documentazione dell'API per merci pericolose. Forniamo inoltre un progetto SoapUI con chiamate di prova realistiche, affinché i suoi sviluppatori possano esplorarla in pochi minuti.
Che cos'è requestGuid e perché è richiesto?
Ogni chiamata all'API deve contenere un requestGuid univoco che identifica la richiesta nei nostri registri e consente alla nostra assistenza di individuare l'esatta transazione quando lei segnala un problema. È accettato qualsiasi valore alfanumerico univoco; consigliamo di generare un UUID/GUID standard sul lato client.
Qual è la causa più frequente di fallimento di una chiamata all'API al primo tentativo?
Credenziali che il servizio non accetta: un'intestazione HTTP Basic Authorization assente o errata oppure, quando la chiamata è autenticata con OAuth2, un token di accesso mai richiesto, appartenente a un altro ambiente o già scaduto. Esiste un indirizzo di assistenza dedicato da interrogare per confermare che l'API risponde e che le credenziali sono valide. Se resta bloccato, ci invii la richiesta e la risposta HTTP complete (compreso il requestGuid) e una descrizione del comportamento atteso: è ciò che sblocca la situazione più rapidamente.