Universal Web Platform ha un web service con cui qualsiasi programma può leggere e scrivere i dati del sito: articoli, prezzi, immagini, giacenze, clienti, ordini e documenti, scadenze, contenuti del sito e tutti gli archivi di Dog House Management. È lo stesso canale che usa Business Intelligence Evolution per pubblicare il catalogo e scaricare gli ordini, e lo puoi usare per collegare il tuo gestionale, un marketplace, un'app, un sistema di logistica o un flusso di automazione.
In queste pagine trovi tutto quello che serve per costruire l'integrazione senza chiedere nulla: come si chiama l'indirizzo, come si autentica la chiamata, come si comprime il corpo, che cosa contengono richiesta e risposta, e per ogni tipo di dato la classe con tutti i campi, il loro significato, i valori predefiniti, i campi chiave e quelli obbligatori.
Come funziona in una frase
Invii in POST a https://<tuo-dominio>/webservice.aspx?Key=<chiave>&serialize=json un oggetto WebServiceRequest in JSON o XML, compresso gzip; il server risponde con un WebServiceResponse compresso allo stesso modo. La richiesta dice che cosa fare (DataOperation), su quale tipo di dato (TypeObject) e, per le scritture, con quali record (la lista ObjectList<Classe> del tipo).
Che cosa puoi fare
| Operazione | Valore | A cosa serve |
|---|
INSERTORMODIFY | 0 | Crea i record nuovi e aggiorna quelli esistenti, riconosciuti dai campi chiave. |
DELETE | 1 | Cancella i record indicati, riconosciuti dai campi chiave. |
TRUNCATETABLE | 2 | Svuota l'intero archivio del tipo indicato. Da usare con estrema cautela. |
QUERY | 3 | Legge i record, con filtro, paginazione, conteggio e sincronizzazione incrementale. |
DELETEALLIMPORTCORRISPONDENZE | 4 | Azzera tutte le conferme di ricezione della postazione: la prossima lettura ricomincia da capo. |
DELETEIMPORTCORRISPONDENZEBYTABLE | 5 | Azzera le conferme di ricezione della postazione per un solo tipo di dato. |
Gli scenari tipici
- Pubblicare il catalogo dal tuo gestionale. Invii in ordine gli archivi di base (marchi, categorie, IVA, unità di misura, listini, varianti), poi gli Articoli, i Prezzi degli articoli, le Immagini degli articoli e le Giacenze.
- Scaricare gli ordini del sito. Leggi i Documenti con QUERY e, record per record, mandi la conferma di ricezione: alla lettura successiva arrivano solo gli ordini nuovi o modificati.
- Allineare clienti e destinazioni. Clienti e fornitori e Destinazioni diverse nei due sensi.
- Tenere aggiornate le quantità. Invii solo le giacenze cambiate, anche ogni pochi minuti.
- Leggere molti tipi in una volta. Con ImportMulti scarichi fino a 64 tipi in una sola chiamata e confermi nello stesso giro quelli ricevuti prima.
Da dove cominciare
- Chiedi all'amministratore del sito una chiave abilitata ai tipi di dato che ti servono, in lettura e o in scrittura: endpoint e chiave di accesso.
- Prepara il trasporto: POST, corpo UTF-8 compresso gzip, risposta gzip: formato e trasporto.
- Costruisci la richiesta: la richiesta, poi scrivere e leggere i dati.
- Controlla sempre lo stato e l'elenco degli errori: la risposta e gli errori.
- Per scaricare solo le novità usa le conferme: sincronizzazione incrementale.
- Per ogni tipo di dato apri la sua pagina dall'elenco dei tipi di dato.
Se scrivi in .NET
La libreria SFHIEDataDefinition contiene tutte le classi descritte qui e la classe Export, che compone la richiesta, la comprime, la invia, ripete i tentativi e restituisce la risposta già deserializzata. Con gli altri linguaggi costruisci gli stessi oggetti in JSON: i nomi dei campi sono identici. Vedi gli esempi di codice.