Sommario
Nel presente articolo sono descritti le funzionalità, la modalità di utilizzo e i principali metodi del Web Service TbService.
Funzionalità TbService
Le funzionalità esposte dal TbService sono:
- gestione istanze del TBLoader
- lettura parametri di filtro di un documento
- gestione dati di un documento
Un'istanza di un TBLoader è un'istanza del prodotto Perfetto in esecuzione.
Il TbService crea e distrugge le istanze di TBLoader e fornisce l'accesso a tutti i documenti del prodotto associati a un Profilo di Esportazione.
Un'applicazione esterna comunica con il TBService utilizzando sempre il token di autenticazione. Il processo di comunicazione segue i seguenti passi:
- chiama il metodo che gestisce la creazione delle istanze di TBLoader
- chiama i metodi che permettono la manipolazione dei dati di un documento
- chiama il metodo che distrugge l'istanza di TBLoader utilizzata
Quali sono i principali metodi?
I metodi principali e più utilizzati da un'applicazione esterna del TbService sono "CreateTb", "CloseTb", "XmlGetParameters", "GetData" e "SetData".
Il metodo CreateTB gestisce la creazione delle istanze di TBLoader. Esso, quando viene invocato, verifica se esiste già un'istanza con utente, password, azienda e data di applicazione uguali alla richiesta inviata al TbService. Se il metodo trova l'istanza utilizza l'istanza trovata per effettuare le chiamate successive altrimenti istanzia un nuovo TBLoader. CreateTB ritorna una stringa di autenticazione al TBLoader chiamata easy token.
Il metodo CloseTb cerca l'istanza associata all'easy token di autenticazione passato al metodo e la distrugge.
Il metodo XmlGetParameters, data una stringa xml contenente il namespace del documento e il profilo di esportazione, ritorna tutti i parametri di filtro consentiti per il documento specificato.
Il metodo GetData restituisce i dati di un documento del prodotto Perfetto in formato xml.
Il metodo SetData fornisce la possibilità di inserire, modificare e cancellare i dati di un documento del prodotto Perfetto, e in alcuni casi restituisce i dati inseriti o modificati.
Per conoscere in dettaglio i metodi esposti dal Web Service TbServices consultare l'articolo TbServices API.
Commenti