Manuale per le API. Mostra come poter inviare in modo programmatico i fax da altre applicazioni tramite le API di GFI FaxMaker.

Transcript

1 Manuale per le API Mostra come poter inviare in modo programmatico i fax da altre applicazioni tramite le API di GFI FaxMaker.

2 Le informazioni e il contenuto del presente documento vengono forniti esclusivamente a scopi informativi e come sono, senza garanzia di alcun tipo, sia espressa che implicita, ivi incluse, in via esemplificativa, tutte le garanzie implicite di commerciabilità, idoneità a soddisfare uno scopo particolare e non violazione dei diritti altrui. GFI Software non sarà ritenuta responsabile di nessun danno, inclusi danni consequenziali, che possano derivare dall uso del presente documento. Le informazioni sono state ottenute da fonti pubblicamente disponibili. Nonostante siano stati compiuti sforzi ragionevoli al fine di garantire la precisione dei dati forniti, GFI non garantisce, promette né tantomeno assicura la completezza, la precisione, l aggiornamento o l adeguatezza di tali dati e non sarà ritenuta responsabile di errori di stampa. GFI non fornisce garanzie, né espresse né implicite e non si assume la responsabilità legale della precisione o della completezza delle informazioni contenute nel presente documento. Se si ritiene che vi siano errori effettivi nel presente documento, contattarci. Provvederemo a risolvere la cosa quanto prima. Windows, Exchange, IIS,.NET, Internet Explorer, Outlook, SQL Server e Microsoft sono marchi registrati o marchi commerciali di Microsoft Corporation negli Stati Uniti e/o in altri paesi. Tutti i nomi di prodotti e società riportati possono essere marchi registrati dei rispettivi proprietari. GFI FaxMaker è un copyright di GFI SOFTWARE Ltd GFI Software Ltd. Tutti i diritti riservati. Versione documento: Ultimo aggiornamento (mese/giorno/anno): 9/18/2014

3 Sommario 1 API di GFI FaxMaker 4 2 API di testo Funzionamento dell API di testo Abilitazione dell API di testo in GFI FaxMaker Creazione di API di testo 7 3 API Funzionamento di API Abilitazione di API in GFI FaxMaker Creazione di API Campi e parametri fax Campi e parametri SMS 22 4 API servizio Web Requisiti e note importanti Guida introduttiva Funzioni API Classi Enums Gestione coda API servizio Web 34 5 Risoluzione dei problemi e supporto Introduzione Knowledge Base Forum Web Richiesta di supporto tecnico Documentazione 37

4 1 API di GFI FaxMaker Cone le API è possibile integrare il software di terze parti con GFI FaxMaker. L automazione di tale processo può essere utilizzata per una vasta gamma di settori e applicazioni, quali la sanità, la vendita al dettaglio e servizi bancari. Ad esempio: utilizzare API nel software di fatturazione per creare un modello di report per gli estratti conto e i bilanci. Generare periodicamente questo report per tutti i clienti che sono in debito verso l azienda e archiviarlo nella cartella di prelievo di API. GFI FaxMaker trasmette automaticamente le dichiarazioni ai rispettivi destinatari. logie di API disponibili in GFI FaxMaker: API API di testo API servizio Web Inviare fax o SMS utilizzando i file. È possibile configurare software di terze parti per generare automaticamente le API e trasmettere i fax in blocco. GFI FaxMaker preleva e trasmette tutti i file xml memorizzati in una cartella di prelievo API. Le API devono essere formattate in base a una convenzione standard, utilizzando campi e parametri che GFI FaxMaker può utilizzare per l elaborazione di fax ed SMS. Per ulteriori informazioni, fare riferimento a API (pagina 11). Inviare i fax utilizzando i file di testo semplici. È possibile configurare software di terze parti per generare automaticamente le API e trasmettere i fax in blocco. GFI FaxMaker preleva e trasmette tutti i file di testo salvati in una cartella di prelievo personalizzata API di testo. Le API di testo devono essere formattate in base a una convenzione standard, utilizzando campi e parametri che GFI FaxMaker può utilizzare per l elaborazione di fax ed SMS. Per ulteriori informazioni, fare riferimento a API di testo (pagina 5). API Servizio Web di GFI FaxMaker consente di sviluppare le proprie applicazioni che è possibile collegare a GFI FaxMaker. È quindi possibile inviare e ricevere fax direttamente dall applicazione. Per ulteriori informazioni, fare riferimento a API servizio Web (pagina 27). GFI FaxMaker 1 API di GFI FaxMaker 4

5 2 API di testo TextAPI è una funzione di GFI FaxMaker che consente la trasmissione di fax dai file di testo. Questi file di testo devono essere formattati in base a una convenzione standard, utilizzando i campi e i parametri che GFI FaxMaker può utilizzare per trasmettere i fax. Archiviare le API di testo in una cartella apposita. GFI FaxMakerpreleva tutte le API di testo archiviate nella cartella e trasmette il contenuto via fax. Per configurare l API di testo: Creare e riservare una cartella accessibile da GFI FaxMaker in cui verranno archiviati i file di testo per la trasmissione fax. Abilitare la funzione TextAPI da GFI FaxMaker. Per ulteriori informazioni, fare riferimento a Abilitazione dell API di testo in GFI FaxMaker (pagina 5). Creare API di testo utilizzando i campi e i parametri accettati da GFI FaxMaker. Per ulteriori informazioni, fare riferimento a Creazione di API di testo (pagina 7). 2.1 Funzionamento dell API di testo Figura 1: Funzionamento dell API di testo Passaggio Generazione TextAPI Un applicazione di terze parti è di solito configurata per generare automaticamente API di testo. Assicurarsi che il file generato soddisfi i parametri, i campi e i requisiti di GFI FaxMaker, come descritto in questo manuale. Per ulteriori informazioni, fare riferimento a Creazione di API di testo (pagina 7). Salvare l API nella cartella di prelievo di TextAPI In GFI FaxMaker configurare le cartelle da cui prelevare le API. Archiviare l API generata nella cartella appropriata. Per ulteriori informazioni, fare riferimento a Abilitazione dell API di testo in GFI FaxMaker (pagina 5). GFI FaxMaker recupera l API GFI FaxMaker esegue periodicamente il polling delle cartelle configurate per le API *.txt. GFI FaxMaker elabora e trasmette il fax GFI FaxMaker elabora le API recuperate e trasmette il fax in base ai campi e ai parametri specificati nell API. NOTA Prima di archiviare le API nella cartella di prelievo, assicurarsi che gli allegati e i file del corpo siano ben archiviati nella posizione corretta. Archiviazione degli allegati nella cartella TextAPI. 2.2 Abilitazione dell API di testo in GFI FaxMaker Per abilitare e configurare l API di testo: GFI FaxMaker 2 API di testo 5

6 1. Dalla configurazione di GFI FaxMaker fare clic con il pulsante destro del mouse sul nodo Avanzate > Testo API/API, quindi selezionare Proprietà. Schermata 1: Abilitazione dell API di testo 2. Dalla scheda API di testo configurare le opzioni seguenti: Tabella 1: Opzioni API di testo Opzione Abilitato Cartelle da scansionare Archivia tutti i file di risposta in una cartella Formattazione testo con frontespizio Abilita API di testo. Specificare le cartella dove salvare le API di testo che devono essere elaborate da GFI FaxMaker. Fare clic su Aggiungi per selezionare le cartelle. Per eseguire la scansione delle API di testo ricorsive nelle sottocartelle, selezionare Includi sottocartelle. Dopo l elaborazione di una TextAPI dove non è indicato il parametro FROM, GFI FaxMaker crea un file di risposta. Per impostazione predefinita, GFI FaxMaker archivia i file di risposta nelle cartelle di prelievo. Per archiviare tutti i file di risposta in un unica posizione, selezionare questa opzione e indicare una posizione. Per ulteriori informazioni, fare riferimento a File di risposta TextAPI (pagina 10). Selezionare il frontespizio da utilizzare per i fax dell API di testo. Per ulteriori informazioni sui frontespizi, fare riferimento a GFI FaxMaker Manuale di amministrazione e configurazione. 3. Fare clic su OK. GFI FaxMaker 2 API di testo 6

7 Passaggio successivo: Iniziare la creazione delle API. Per ulteriori informazioni, fare riferimento a Creazione di API di testo (pagina 7). 2.3 Creazione di API di testo Quando si utilizza TextAPI, creare un file di testo (formato.txt) strutturato come segue: Tabella 2: Struttura del file TextAPI Riga Prima riga Seconda riga (facoltativa) Altre righe Specificare il numero di fax del destinatario preceduto dal doppio simbolo dei due punti nel formato seguente: ::numero fax Ad esempio: :: Nel formato seguente è inoltre possibile includere altri parametri: ::nome, azienda, cognome, ufficio, indirizzo , numero fax Ad esempio, per inviare un fax ad Andrea Rossi che lavora nell'ufficio vendite di Azienda Giovanni, il cui indirizzo di posta elettronica e numero di fax sono rispettivamente vendite@aziendagiovanni.com e , si dovrà inserire: ::John, John Company, Smith, Sales, sales@johncompany.com, Specificare le altre opzioni di invio precedute dal doppio simbolo dei due punti. Ad esempio: ::S=listino prezzi Separare più parametri con virgole. Ad esempio: ::c=cover1,23:15,b=5 Per ulteriori informazioni, fare riferimento a Opzioni di invio API di testo (pagina 7). Immettere il testo del messaggio da inviare per fax Opzioni di invio API di testo Nella seconda riga dell API di testo è possibile specificare una serie di opzioni di invio. NOTA È possibile specificare più opzioni. Separare più parametri con virgole. Ad esempio: ::s=oggetto,from=peter,c=frontespizio1,23:15,b=5 NOTA Per GFI FaxMaker non si applica la distinzione tra maiuscole e minuscole. I parametri possono essere specificati sia con le lettere maiuscole che con le lettere minuscole. Tabella 3: Parametri API di testo Opzione di invio Oggetto Parametro ::S=Questo è l oggetto o ::subject=questo è l oggetto Specificare l'oggetto del fax. Questo testo viene inserito nel campo <subject> del frontespizio. Sostituire Questo è l oggetto con il testo dell oggetto. GFI FaxMaker 2 API di testo 7

8 Opzione di invio Mittente Parametro ::fr=nome o ::from=nome Utilizzare il parametro per specificare il nome del mittente del fax. Il nome specificato è incluso come nome mittente nel frontespizio. Sostituire nome con il nome del mittente. NOTA: Quando l opzione non è specificata, GFI FaxMaker non dispone di informazioni sul mittente e non è pertanto in grado di restituire un report di trasmissione via . Invece, viene generato un file di risposta. Per ulteriori informazioni, fare riferimento a File di risposta TextAPI (pagina 10). Allegato ::A=Nome file Specificare un file da allegare al fax. Il file deve essere archiviato nella stessa cartella di prelievo di TextAPI. Priorità Codice di addebito Pianifica Priorità alta ::p=high o ::p=h o ::priority=high o ::priority=h Priorità bassa ::p=low o ::p=l o ::priority=low o ::priority=l ::B=nnnn o ::billingcode=nnnn ::YYYY-MM-DD-hh:mm:ss o ::hh:mm Sostituire nome file con il nome e l estensione del file da allegare. Ad esempio, ::A=FaxAttachment.tif È possibile allegare più file specificando il comando più volte. Ad esempio: ::A=FaxAttachment.tif,A=disclaimer.tif NOTA: Gli allegati vengono rimossi definitivamente dalla cartella di prelievo. Se è necessaria una copia, assicurarsi che venga eseguita prima di spostare l allegato nella cartella TextAPI. Specificare la priorità del fax (alta o bassa) da utilizzare per inviare il fax. Utilizzare questo parametro per specificare un codice di addebito, se GFI FaxMaker è configurato per richiederne uno. Sostituire nnnn con il codice di addebito. Specificare la data e l ora, oppure soltanto l ora, in cui inviare il fax. Sostituire: AAAA - anno MM - mese DD - giorno hh - ora nel formato 24 ore mm - minuti ss - secondi Ad esempio, :: :05:00 GFI FaxMaker 2 API di testo 8

9 Opzione di invio Frontespizio Nota di copertina anteriore Linea fax massima Intestazione Riepilogo report di trasmissione Parametro ::C=NomeFrontespizio o ::Coverpage=NomeFrontespizio ::F=NotaCopertina o ::frontcover=notacopertina ::line=n o ::l=n Alta risoluzione ::H o ::high Risoluzione normale ::N o ::normal ::fh=intestazione o ::faxheader=intestazione Invia riepilogo report di trasmissione ::tr=summary Non mandare mai riepilogo ::tr=none Per impostazione predefinita, GFI FaxMaker utilizza il frontespizio predefinito configurato in GFI FaxMaker. Utilizzare questo parametro per inviare fax con un determinato frontespizio. Sostituire NomeFrontespizio con il nome del frontespizio da usare, come configurato in GFI FaxMaker. È inoltre possibile utilizzare ::C=none per non aggiungere un frontespizio. Utilizzare questo parametro per inviare fax con una determinata nota di copertina anteriore. Sostituire NotadicopertinaAnteriore con il nome della nota di copertina anteriore da usare, come configurato in GFI FaxMaker. Specificare questo parametro per richiedere che il fax venga inviato tramite una determinata linea fax. Sostituire n con il numero della linea fax come configurato in Configurazione di GFI FaxMaker. NOTA: Se la linea è occupata o non è disponibile, il fax viene inviato usando un'altra linea. Per inviare il fax unicamente da una linea particolare, utilizzare il parametro seguente: ::dl=n Il fax non viene inviato fino a quando la linea fax specificata non è disponibile. NOTA: il parametro dl è disponibile anche durante l utilizzo dei comandi TextAPI negli SMS per la richiesta di invio di un SMS tramite una specifica linea GSM. Utilizzare il parametro per specificare la risoluzione del fax. Utilizzare una risoluzione elevata (200 * 200 dpi) o normale (200 * 100 dpi). Questa opzione consente di impostare un'intestazione personalizzata aggiunta a quella predefinita all'inizio del fax. Sostituire intestazione con il testo dell intestazione da aggiungere. Usare summary per ricevere solo un report di trasmissione all invio di un fax a destinatari multipli. Usare none per non inviare un report di trasmissione dopo la trasmissione fax di TextAPI ::John, società di John, Smith, Sales, sales@johnscompany.com, ::from=bob Jones,subject=Hi John,H,fh=Fax di prova Questo è il messaggio del fax. Cordiali saluti, Paul GFI FaxMaker 2 API di testo 9

10 2.3.3 File di risposta TextAPI Dopo aver elaborato un TextAPI dove non è specificato il mittente (opzioni from o fr nella seconda riga), GFI FaxMaker crea un file di risposta per indicare il risultato della trasmissione fax. Se il mittente è specificato, il messaggio di risposta viene inviato per al mittente come rapporto di trasmissione. Per impostazione predefinita, il file di risposta viene creato nella medesima cartella da cui è stato prelevato TextAPI. In alternativa, GFI FaxMaker può essere configurato per archiviare tutti i file di risposta in un percorso. Per ulteriori informazioni, fare riferimento a Archivia tutti i file di risposta in una cartella (pagina 6). Il nome del file di risposta corrisponde al nome di TextAPI. L estensione del file dipende dal risultato di trasmissione: *.ok: indica che il fax è stato trasmesso correttamente. *.err: indica che non è stato possibile inviare il fax. Per facilitare la risoluzione dei problemi, rivedere il messaggio Description. Schermata 2: Messaggio di risposta TextAPI di esempio GFI FaxMaker 2 API di testo 10

11 3 API API è una funzione di GFI FaxMaker che consente la trasmissione di fax dai file. I file devono essere formattati in base a una convenzione standard, utilizzando i campi e i parametri che GFI FaxMaker può utilizzare per trasmettere i fax. Archiviare le API in una cartella apposita. GFI FaxMakerpreleva tutte le API archiviate nella cartella e trasmette il contenuto via fax. Per configurare le API: Creare e riservare una cartella accessibile da GFI FaxMaker in cui saranno archiviati i file per la trasmissione fax. Abilitare la funzione API da GFI FaxMaker. Per ulteriori informazioni, fare riferimento a Abilitazione di API in GFI FaxMaker (pagina 12). Creare API utilizzando i campi e i parametri accettati da GFI FaxMaker. Per ulteriori informazioni, fare riferimento a Creazione di API (pagina 13). 3.1 Funzionamento di API Figura 2: Funzionamento di API Passaggio Generazione API Un applicazione di terze parti è di solito configurata per generare automaticamente le API. Assicurarsi che il file generato soddisfi i parametri, i campi e i requisiti di GFI FaxMaker. Per ulteriori informazioni, fare riferimento a Creazione di API (pagina 13). Archiviazione dell API nella cartella di prelievo API In GFI FaxMaker configurare le cartelle da cui prelevare le API. Archiviare l API generata nella cartella appropriata. Per ulteriori informazioni, fare riferimento a Abilitazione di API in GFI FaxMaker (pagina 12). GFI FaxMaker recupera l API GFI FaxMaker esegue periodicamente il polling delle cartelle configurate per le API +.xml. GFI FaxMaker elabora e trasmette il fax/l SMS GFI FaxMaker elabora le API recuperate e trasmette il fax/l SMS in base ai campi e ai parametri specificati nell API. NOTA Prima di archiviare le API nella cartella di prelievo, assicurarsi che gli allegati e i file del corpo siano ben archiviati nella posizione corretta. Archiviazione degli allegati e/o del file del corpo nella cartella API oppure in un percorso personalizzato (come configurato entro i parametri dell API). GFI FaxMaker 3 API 11

12 NOTA Dopo aver trasmesso un fax con API, GFI FaxMaker genera un messaggio di risposta (file *.status) nella cartella API che include i dettagli relativi alla trasmissione fax. Questo può essere utilizzato dagli utenti, amministratori o dalle applicazioni di terzi per monitorare la trasmissione fax. Per ulteriori informazioni, fare riferimento a File di risposta API (pagina 21). 3.2 Abilitazione di API in GFI FaxMaker Per abilitare e configurare API: 1. Dalla configurazione di GFI FaxMaker fare clic con il pulsante destro del mouse sul nodo Avanzate > Testo API/API, quindi selezionare Proprietà. Schermata 3: Abilitazione di API 2. Dalla scheda API, fare clic su Aggiungi e selezionare le cartelle in cui archiviare le API. Per controllare la presenza di API anche nelle sottocartelle, selezionare Includi sottocartelle. 3. Dopo aver elaborato un API, GFI FaxMaker crea un file di risposta (estensione *.status). Per impostazione predefinita, GFI FaxMaker archivia i file di risposta nelle cartelle di prelievo. Per archiviare tutti i file di risposta in un unica posizione, selezionare Archivia tutti i file di risposta in GFI FaxMaker 3 API 12

13 una cartella e indicare una posizione. Per ulteriori informazioni, fare riferimento a File di risposta API (pagina 21). 3. Fare clic su OK. Passaggio successivo: Iniziare la creazione delle API. Per ulteriori informazioni, fare riferimento a Creazione di API (pagina 13). 3.3 Creazione di API Quando si utilizza API, creare un file (formato.xml) contenente i parametri del fax/sms da trasmettere. Tutti i parametri API devono essere compresi in un contenitore <faxmakerdata>. I dati devono quindi essere inclusi in tre contenitori separati, come segue: Tabella 4: Contenitori campo API Contenitori API <fields> <sender> <recipients> Per questo contenitore devono essere specificate le proprietà di trasmissione fax quali oggetto, file allegato e messaggio. Inserire i dettagli del mittente in questo contenitore. Specificare le informazioni dei destinatari in questo contenitore. NOTA È necessaria anche un intestazione. Di solito si presenta nel modo seguente: <?xml version="1.0" encoding="utf-8"?> Per ulteriori informazioni sui campi e parametri API, fare riferimento a: Campi e parametri fax Campi e parametri SMS API di esempio <?xml version="1.0" encoding="utf-8"?> <faxmakerdata> <fields> <subject>questo è l oggetto del fax</subject> <bodyfile type="text/plain">c:\temp\bodyfile.txt</bodyfile> <attachment>c:\temp\document.txt</attachment> </fields> <sender> < address>utente@dominiomittente.com</ address> </sender> <recipients> <fax> <recipient> <faxnumber> </faxnumber> GFI FaxMaker 3 API 13

14 </recipient> </fax> </recipients> </faxmakerdata> Esempi più completi dell API sono inclusi in questo manuale: API per fax di esempio API per SMS di esempio 3.4 Campi e parametri fax Elenco dei campi e parametri supportati in API per l invio di fax. Campi dei messaggi Informazioni sul mittente Informazioni sui destinatari del fax Fare riferimento al fax di esempio API. Per ulteriori informazioni, fare riferimento a API per fax di esempio (pagina 20) Campi dei messaggi Nel contenitore <fields>, specificare le informazioni seguenti: Tabella 5: Campi e parametri dei messaggi Oggetto Pianifica \faxmakerdata\fields\subject Specificare l'oggetto del fax. <subject>questo è l oggetto del fax</subject> \faxmakerdata\fields\schedule Specificare la data e l ora di invio del fax nel formato seguente: YYYY-MM-DD-HH:mm:ss Sostituire: AAAA - anno MM - mese DD - giorno hh - ora nel formato 24 ore mm - minuti ss - secondi <schedule> :15:00</schedule> GFI FaxMaker 3 API 14

15 Priorità \faxmakerdata\fields\priority Impostare la priorità del messaggio. I valori validi sono: low normal high Codice di addebito massima Frontespizio Nota di copertina anteriore veryhigh <priority>high</priority> \faxmakerdata\fields\billingcode. Obbligatorio quando è abilitato il codice di addebito. Imposta il codice di addebito del mittente del messaggio. <billingcode>25</billingcode> \faxmakerdata\fields\resolution Utilizzare il parametro per specificare la risoluzione del fax. I valori validi sono: Normal (200 * 100 dpi) High (200 * 200 dpi) <resolution>high</resolution> \faxmakerdata\fields\coverpage Per impostazione predefinita, il fax viene inviato utilizzando il frontespizio configurato in GFI FaxMaker. Utilizzare questo parametro per inviare fax con un determinato frontespizio. Digitare il frontespizio da utilizzare scegliendo una delle seguenti opzioni: Nome del frontespizio come configurato in GFI FaxMaker. Il nome file di un frontespizio archiviato nella <cartella di installazione di GFI FaxMaker>\Coverpage. Ad esempio, generic.htm. <coverpage>aziendale</coverpage> \faxmakerdata\fields\frontcovernote Per impostazione predefinita, il fax viene inviato utilizzando la nota di copertina anteriore predefinita configurata in GFI FaxMaker. Utilizzare questo parametro per inviare fax con una determinata nota di copertina anteriore. Digitare la nota di copertina anteriore da utilizzare scegliendo una delle seguenti opzioni: Nome della nota di copertina anteriore come configurato in GFI FaxMaker. Il nome file di una nota di copertina anteriore archiviato in <cartella di installazione di GFI FaxMaker>\Coverpage. Ad esempio, MyCovernote.htm. <frontcovernote>intestazione lettera</frontcovernote> GFI FaxMaker 3 API 15

16 Linea fax Intestazione ID univoco API di testo \faxmakerdata\fields\faxline Numero Utilizzare questo parametro per richiedere che il fax venga inviato tramite una determinata linea fax. Specificare il numero della linea fax come configurato in Configurazione di GFI FaxMaker. NOTA: Se la linea è occupata o non è disponibile, il fax viene inviato usando un'altra linea. Per inviare il fax unicamente da una linea specifica, utilizzare l attributo seguente: demandline= true <faxline demandline="true">3</faxline> \faxmakerdata\fields\faxheader Immettere un'intestazione personalizzata aggiunta a quella all'inizio del fax. <faxheader>questa è l intestazione del fax</faxheader> \faxmakerdata\fields\uid [255 caratteri al massimo] Specificare un identificatore che viene utilizzato per contrassegnare il messaggio. L'univocità dell'identificatore è stabilita dall'autore del messaggio. Il numero massimo di caratteri è 255. <uid>3a5a90s7de3g20k9y4d5e7e6fse28se5e097</uid> \faxmakerdata\fields\textapi Utilizzato per specificare una linea singola di comandi di API di testo (incluso il prefisso ':: ). Questo campo può essere specificato più volte. <textapi>::billingcode=25,line=3</textapi> GFI FaxMaker 3 API 16

17 File del corpo del messaggio Allegato \faxmakerdata\fields\bodyfile completo o nome file NOTA: È necessario un file allegato o un file del corpo del messaggio del fax. Utilizza i contenuti del file come corpo del messaggio nel frontespizio del fax. Digitare il percorso completo del file oppure immettere solo il nome del file se il file del corpo è archiviato nella cartella frontespizi: <cartella di installazione di GFI FaxMaker>\Coverpage. NOTA: Se è stato immesso il percorso completo, il file verrà eliminato una volta elaborato. Specificare il tipo di file. Utilizzare uno dei seguenti attributi: type="text/html" - Specificare questo attributo quando il testo del corpo del messaggio è nel formato HTML. type="text/rtf": specificare questo attributo quando il testo del corpo del messaggio è nel formato RTF. Utilizzare i file con corpo del messaggio RTF solo con i frontespizi RTF. type="text/plain" - Specificare questo attributo quando il testo del corpo del messaggio è nel formato testo normale. Se non è specificato alcun attributo del tipo di file, il messaggio viene immesso come testo normale. <bodyfile type="text/plain">c:\temp\bodyfile.txt</bodyfile> \faxmakerdata\fields\attachment completo o nome file (massimo 60 allegati) NOTA: È necessario un file allegato o un file del corpo del messaggio del fax. Allega il contenuto del file specificato al fax. Digitare il percorso completo del file oppure immettere solo il nome del file se il file del corpo è archiviato nella stessa cartella dell API. NOTA: Prima di archiviare i file API nella cartella di prelievo, assicurarsi che gli allegati siano ben archiviati nella posizione corretta. NOTA: Se è stato immesso il percorso completo, il file verrà eliminato una volta elaborato. <attachment>c:\temp\document.doc</attachment> Campi del mittente Nel contenitore <sender> specificare le seguenti informazioni sul mittente: Tabella 6: Campi e parametri del mittente Nome \faxmakerdata\sender\firstname Imposta il nome del mittente. <firstname>john</firstname> Cognome \faxmakerdata\sender\lastname Imposta il cognome del mittente. <lastname>smith</lastname> GFI FaxMaker 3 API 17

18 Azienda \faxmakerdata\sender\company Imposta il nome dell'azienda del mittente. <company>nome azienda</company> Reparto \faxmakerdata\sender\department Imposta il reparto del mittente. <department>vendita</department> Numero telefono \faxmakerdata\sender\voicenumber Imposta il numero di telefono del mittente. <voicenumber>+1(800) </voicenumber> Indirizzo di posta elettronica \faxmakerdata\sender\ address Obbligatorio Imposta l'indirizzo di posta elettronica del mittente Campi dei destinatari del fax Nel contenitore <recipient>, specificare le informazioni seguenti. Per i fax, aggiungere un contenitore <fax> e un contenitore <recipient>. Ad esempio: <recipients> <fax> <recipient> <faxnumber> </faxnumber> </recipient> </fax> </recipients> NOTA È inoltre possibile inviare il fax a più destinatari. Per ulteriori informazioni, fare riferimento a Invio di fax a più destinatari (pagina 19). Inserire altri parametri e campi nel contenitore <recipient> come segue: GFI FaxMaker 3 API 18

19 Tabella 7: Campi e parametri dei destinatari del fax Nome Cognome Azienda Reparto Numero fax Numero telefono Indirizzo di posta elettronica \faxmakerdata\recipients\fax\recipient\firstname Imposta il nome del destinatario. <firstname>joe</firstname> \faxmakerdata\recipients\fax\recipient\lastname Imposta il cognome del destinatario. <lastname>bloggs</lastname> \faxmakerdata\recipients\fax\recipient\company Imposta il nome dell'azienda del destinatario. <company>destinatariofax azienda Ltd.</company> \faxmakerdata\recipients\fax\recipient\department Imposta il reparto del destinatario. <department>marketing</department> \faxmakerdata\recipients\fax\recipient\faxnumber Obbligatorio Imposta il numero di fax del destinatario. <faxnumber>+1(800) </faxnumber> \faxmakerdata\recipients\fax\recipient\voicenumber Imposta il numero di telefono del destinatario. <voicenumber>+1(800) </voicenumber> \faxmakerdata\recipients\fax\recipient\ address Imposta l'indirizzo di posta elettronica del destinatario. < address>john@dominiodestinatariofax.com</ address> Invio di fax a più destinatari È possibile inviare il fax a più destinatari. A tale scopo, includere più contenitori <recipient>...</recipient>. Ad esempio: <recipients> <fax> GFI FaxMaker 3 API 19

20 <recipient> <firstname>bob</firstname> <faxnumber> </faxnumber> </recipient> <recipient> <firstname>john</firstname> <faxnumber> </faxnumber> </recipient> </fax> </recipients> API per fax di esempio NOTA Per questo esempio vengono utilizzati altri due file: Allegato: un allegato mswordfile.doc è archiviato in c:\temp\ File del corpo: un file di testo normale bodyfile.txt è archiviato in c:\temp\ Questi file verranno eliminati da c:\temp\ quando il fax verrà recuperato da GFI FaxMaker. <?xml version="1.0" encoding="utf-8"?> <faxmakerdata> <fields> <subject>questo è l oggetto del fax</subject> <schedule> :15:00</schedule> <priority>high</priority> <billingcode>25</billingcode> <resolution>high</resolution> <coverpage>aziendale</coverpage> <frontcovernote>intestazione lettera</frontcovernote> <faxline demandline="true">3</faxline> <faxheader>questo è il testo dell intestazione del fax</faxheader> <bodyfile type="text/plain">c:\temp\bodyfile.txt</bodyfile> <attachment>c:\temp\mswordfile.doc</attachment> <uid>3a5a90s7de3g20k9y4d5e7e6fse28se5e097</uid> </fields> <sender> <firstname>john</firstname> <lastname>smith</lastname> GFI FaxMaker 3 API 20

21 <company>azienda Ltd.</company> <department>vendita</department> <faxnumber> </faxnumber> <voicenumber> </voicenumber> </sender> <recipients> <fax> <recipient> <firstname>joe</firstname> <lastname>bloggs</lastname> <company>azienda JohnBloggs</company> <department>marketing</department> <faxnumber> </faxnumber> <voicenumber> </voicenumber> </recipient> </fax> </recipients> </faxmakerdata> File di risposta API Dopo aver elaborato un API, GFI FaxMaker crea un file di risposta nella cartella API che può essere utilizzato per rivedere la trasmissione fax. L estensione del file di risposta è *.status. Gli strumenti di terze parti possono essere configurati per eseguire il polling della cartella e recuperare automaticamente lo stato dei fax trasmessi. NOTA La trasmissione SMS non genera il file di risposta. GFI FaxMaker 3 API 21

22 Schermata 4: Messaggio risposta di esempio API Il messaggio di risposta contiene i seguenti contenitori : Tabella 8: Contenitori del messaggio di risposta Contenitore <fax>...</fax> <errorcode>...</errorcode> <description>...</description> <uid>...</uid> <faxfile>...</faxfile> <recipient>...</recipient> Contenitore per ciascuna trasmissione fax. Se un file API contiene destinatari multipli, viene creato un contenitore <fax> per ciascun destinatario, con tutti i dettagli per quella trasmissione specifica. Restituisce il codice di errore per la trasmissione fax. Una trasmissione riuscita restituisce il codice di errore 0. Contiene il report di trasmissione per le trasmissioni con esito positivo o negativo. Include parametri importanti relativi al fax. Se è stato specificato un ID univoco (uid) in API, questo contenitore viene prodotto. Contiene il percorso completo del file immagine del fax. Mostra il numero di fax a cui è stato inviato il fax. 3.5 Campi e parametri SMS Elenco dei campi e parametri supportati in API per l invio di SMS. GFI FaxMaker 3 API 22

23 Campi dei messaggi Informazioni sul mittente Informazioni sui destinatari dell SMS Fare riferimento all SMS di esempio API. Per ulteriori informazioni, fare riferimento a API per SMS di esempio (pagina 26) Campi dei messaggi Nel contenitore <fields>, specificare le informazioni seguenti: Messaggio SMS Linea SMS \faxmakerdata\fields\bodyfile completo o nome file Obbligatorio Utilizza i contenuti del file come messaggio SMS. Digitare il percorso completo del file. Specificare il tipo di file: type="text/html": il testo del corpo del messaggio è nel formato HTML. type="text/rtf": il testo del corpo del messaggio è nel formato RTF. type="text/plain": il testo del corpo del messaggio è nel formato testo normale. Se non è specificato alcun attributo del tipo di file, il messaggio viene elaborato come testo normale. <bodyfile type="text/plain">c:\temp\bodyfile.txt</bodyfile> \faxmakerdata\fields\gsmline Numero (porta COM) o stringa (nome configurato per la linea GSM) Richiedere l invio di un SMS a una determinata linea GMS. Indicare il nome o il numero della porta COM come configurato in GFI FaxMaker. Utilizzare il parametro demandline per indicare le modalità di invio degli SMS se la linea indicata è occupata o inesistente. Per inviare l SMS unicamente dalla linea GSM specificata, utilizzare demandline= true. Utilizzare demandline= false per inviare l SMS tramite la prima linea GSM disponibile se la linea indicata è occupata o inesistente. <gsmline demandline="true">3</gsmline> o <gsmline demandline="false">mygsmline</gsmline> Campi del mittente Nel contenitore <sender> specificare le seguenti informazioni sul mittente: Tabella 9: Campi e parametri del mittente Nome \faxmakerdata\sender\firstname Imposta il nome del mittente. <firstname>john</firstname> GFI FaxMaker 3 API 23

24 Cognome \faxmakerdata\sender\lastname Imposta il cognome del mittente. <lastname>smith</lastname> Azienda \faxmakerdata\sender\company Imposta il nome dell'azienda del mittente. <company>nome azienda</company> Reparto \faxmakerdata\sender\department Imposta il reparto del mittente. <department>vendita</department> Numero telefono \faxmakerdata\sender\voicenumber Imposta il numero di telefono del mittente. <voicenumber>+1(800) </voicenumber> Indirizzo di posta elettronica \faxmakerdata\sender\ address Obbligatorio Imposta l'indirizzo di posta elettronica del mittente Campi dei destinatari dell SMS Nel contenitore <recipient>, specificare le informazioni seguenti. Per gli SMS, aggiungere un contenitore <sms> e un contenitore <recipient>. Ad esempio: <recipients> <sms> <recipient> <smsnumber> </smsnumber> </recipient> </sms> </recipients> NOTA È inoltre possibile inviare l SMS a più destinatari. Per ulteriori informazioni, fare riferimento a Invio di SMS a destinatari multipli (pagina 25). Inserire altri parametri e campi nel contenitore <recipient> come segue: GFI FaxMaker 3 API 24

25 Tabella 10: Campi e parametri dei destinatari dell SMS Nome Cognome Azienda Reparto Numero SMS Numero telefono Indirizzo di posta elettronica \faxmakerdata\recipients\sms\recipient\firstname Imposta il nome del destinatario. <firstname>joe</firstname> \faxmakerdata\recipients\sms\recipient\lastname Imposta il cognome del destinatario. <lastname>bloggs</lastname> \faxmakerdata\recipients\sms\recipient\company Imposta il nome dell'azienda del destinatario. <company>destinatariosms azienda Ltd.</company> \faxmakerdata\recipients\sms\recipient\department Imposta il reparto del destinatario. <department>marketing</department> \faxmakerdata\recipients\sms\recipient\smsnumber Obbligatorio Imposta il numero di SMS del destinatario. <smsnumber>+1(800) </smsnumber> \faxmakerdata\recipients\sms\recipient\voicenumber Imposta il numero di telefono del destinatario. <voicenumber>+1(800) </voicenumber> \faxmakerdata\recipients\sms\recipient\ address Imposta l'indirizzo di posta elettronica del destinatario. < address>john@dominiodestinatariosms.com</ address> Invio di SMS a destinatari multipli È possibile inviare l SMS a più destinatari. A tale scopo, includere più contenitori <recipient>...</recipient>. Ad esempio: <recipients> <sms> GFI FaxMaker 3 API 25

26 <recipient> <firstname>john</firstname> <smsnumber> </smsnumber> </recipient> <recipient> <firstname>bob</firstname> <smsnumber> </smsnumber> </recipient> </sms> </recipients> API per SMS di esempio NOTA Per questo esempio viene utilizzato un altro file. bodyfile.txt. Il file è archiviato in c:\temp\ e contiene il testo del messaggio sms. Questo file verrà eliminato da c:\temp\ quando l SMS verrà recuperato da GFI FaxMaker. <?xml version="1.0" encoding="utf-8"?> <faxmakerdata> <fields> <bodyfile type="text/plain">c:\temp\bodyfile.txt</bodyfile> </fields> <sender> < address>jsmith@azienda.com</ address> </sender> <recipients> <sms> <recipient> <smsnumber> </smsnumber> </recipient> </sms> </recipients> </faxmakerdata> GFI FaxMaker 3 API 26

27 4 API servizio Web API Servizio Web di GFI FaxMaker consente di sviluppare le proprie applicazioni che è possibile collegare a GFI FaxMaker per l invio/ricezione di fax/sms. NOTA Questo argomento è destinato agli utenti familiari con Visual Studio, Servizi Web e tecnologie SOAP. 4.1 Requisiti e note importanti Guida introduttiva Funzioni API Classi Enums Gestione coda API servizio Web Requisiti e note importanti Per creare l API, utilizzare un ambiente di sviluppo che supporta Servizi Web e SOAP. API servizio Web di GFI FaxMaker utilizza la porta 8555 per la comunicazione HTTP tra l applicazione e GFI FaxMaker. Questa porta può essere aperta automaticamente durante l esecuzione della configurazione guidata di GFI FaxMaker. Per ulteriori informazioni, fare riferimento a Accedere al Servizio Web di GFI FaxMaker tramite Servizi Web sulla porta HTTP 8555, tramite l URL: GFI FaxMaker>:8555/faxmaker/wsapi Sostituire <Server GFI FaxMaker> con il nome o l indirizzo IP del server di GFI FaxMaker. Ad esempio In alternativa, è possibile utilizzare una connessione sicura tramite HTTPS. Per ulteriori informazioni, fare riferimento a Dal nodo Utenti con licenza registrare gli utenti che utilizzeranno API Servizio Web. Utilizzare le credenziali di questo utente nelle chiamate API. I fax ricevuti che vengono inoltrati agli utenti registrati per API Servizio Web vengono salvati nella coda di API Servizio Web e non inoltrati all utente tramite . Configurare le regole di routing per l inoltro di fax da prelevare da API Servizio Web agli utenti registrati. GFI FaxMaker conserva i fax ricevuti nella coda di API Servizio Web per 30 giorni. I fax scaduti non possono essere recuperati da API Servizio Web. Per ulteriori informazioni, fare riferimento a Gestione coda API servizio Web (pagina 34). GFI FaxMaker 4 API servizio Web 27

28 4.2 Guida introduttiva 1. In Visual Studio, creare un applicazione C# Windows o Console. 2. Da Esplora soluzioni, fare clic con il pulsante destro del mouse su Riferimento e Aggiungi riferimento Web. 3. Inserire l URL del Servizio Web (collegamento WDSL) e fare clic su Vai. 4. Fare clic su Aggiungi riferimento per creare le classi necessarie. 5. Nel codice, aggiungere un riferimento allo spazio dei nomi creato da Visual Studio. 6. Utilizzare le seguenti classi di spazio dei nomi come classi tipiche di C#. 4.3 Funzioni API SendFax Utilizzare questa funzione per inviare un fax. La funzione restituisce una matrice di FaxJobIDs. Per ogni destinatario indicato, viene creato un FaxJobID. Questo ID consente di monitorare lo stato del fax inviato a quel destinatario specifico. FMResult SendFax ( ); Parametri: FMUser user, UserDetails senderdetails, List<UserDetails> recipients, MessageDetails messagedetails, out FaxJobID[] faxjobids Parametro user senderdetails recipients[] messagedetails Le credenziali dell utente API Web. I dati dell utente. Elenco di destinatari del fax. Il fax da inviare. Valori restituiti: Parametro FMResult Faxjobids Restituisce il risultato della funzione. Una matrice di faxjobid. Per ogni destinatario vi è un id processo. Questo id processo può essere utilizzato successivamente per ottenere lo stato di un fax specifico. GFI FaxMaker 4 API servizio Web 28

29 4.3.2 CheckForUnreadFaxes Utilizzare questa funzione per ottenere l elenco di fax nella coda. La coda contiene tutti i fax che non sono stati scaricati in precedenza. Ogni elemento dell elenco contiene solo i dati del fax e non l immagine effettiva. Per scaricare il fax utilizzare GetNextFax(). FMResult CheckForUnreadFaxes ( ); Parametri: FMUser user, out ReceivedFaxDetails[] receivedfaxes Parametro user Le credenziali dell utente API Web. Valori restituiti: Parametro FMResult receivedfaxes Restituisce il risultato della funzione. Una matrice di ReceivedFaxDetails GetSendingFaxStatusUpdates Utilizzare questa funzione per ottenere lo stato di un fax precedentemente inviato mediante l API SendFax. FMResult GetSendingFaxStatusUpdates ( ); Parametri: FMUser user, long FaxJobID, out FaxSendingStatus FaxStatus Parametro user FaxJobID Le credenziali dell utente API Web. L identificatore univoco assegnato a ciascun destinatario di un fax in uscita. Valori restituiti: Parametro FMResult FaxStatus Restituisce il risultato della funzione. Restituisce lo stato del fax. GFI FaxMaker 4 API servizio Web 29

30 4.3.4 GetNextFax Utilizzare questo metodo per ottenere il fax meno recente della coda. La coda contiene tutti i fax che non sono stati scaricati in precedenza. Quando si recupera il fax meno recente, non viene automaticamente eliminato dalla coda. Chiamare DeleteFax() per eliminare il fax meno recente, consentendo di ottenere il successivo. Se il fax meno recente non viene eliminato, verrà ricevuto nuovamente. FMResult GetNextFax ( ); Parametri: FMUser user, out ReceivedFaxDetails faxdetails, out FileData fax Parametro user Le credenziali dell utente API Web. Valori restituiti: Parametro FMResult faxdetails fax Restituisce il risultato della funzione. ReceivedFaxDetails conserva i dati del fax L'immagine fax GetNextFaxByCriteria Utilizzare questo metodo per ottenere il fax meno recente della coda, in base ai criteri indicati. La coda contiene tutti i fax che non sono stati scaricati in precedenza. Quando si recupera il fax meno recente, non viene automaticamente eliminato dalla coda. Chiamare DeleteFax() per eliminare il fax meno recente, consentendo di ottenere il successivo. Se il fax meno recente non viene eliminato, verrà ricevuto nuovamente. FMResult GetNextFaxByCriteria ( ); FMUser user, SearchCriteria criteria, stringcriteriavalue, out ReceivedFaxDetails faxdetails, out FileData fax GFI FaxMaker 4 API servizio Web 30

31 Parametri: Parametro user Criteri Criteriavalue Le credenziali dell utente API Web. DTMF o id remoto Il valore dei criteri Valori restituiti: Parametro FMResult faxdetails Fax Restituisce il risultato della funzione. ReceivedFaxDetails conserva i dati del fax FileData contiene i dati immagine fax effettivi DeleteFax Utilizzare questa funzione per eliminare un fax specifico. FMResult DeleteFax ( FMUser user, int FaxID ); Parametri: Parametro user FaxID Le credenziali dell utente API Web. L ID del fax da eliminare. Questo valore può essere recuperato dall output di CheckForUnreadFaxes(), GetNextFax() o GetNextFaxByCriteria(). Valori restituiti: Parametro FMResult Restituisce il risultato della funzione. 4.4 Classi UserDetails Questa classe contiene i dettagli del destinatario/mittente. Tutti i campi sono facoltativi, eccetto la proprietà Faxnumber quando viene utilizzata come destinatario. Membri dati Firstname Nome. Lastname Cognome. Company Nome azienda. GFI FaxMaker 4 API servizio Web 31

32 Membri dati Department Nome reparto. numerofax Il numero del fax. L indirizzo MessageDetails Un oggetto di questa classe contiene i dettagli di un nuovo fax. Tutti i campi sono facoltativi, eccetto la proprietà BillingCode quando Billing è abilitato. Membri dati Subject L oggetto del fax. Schedule DateTime Una data e ora specifica di invio del fax. Priority FaxPriority Imposta la priorità del fax. BillingCode Indica il codice di fatturazione. Obbligatorio quando è abilitato il codice di addebito. Resolution FaxResolution La risoluzione da utilizzare. Coverpage Per impostazione predefinita, il fax viene inviato utilizzando il frontespizio configurato in GFI FaxMaker. Utilizzare questo parametro per inviare fax con un determinato frontespizio. FrontCoverNote Per impostazione predefinita, il fax viene inviato utilizzando la nota di copertina anteriore predefinita configurata in GFI FaxMaker. Utilizzare questo parametro per inviare fax con una determinata nota di copertina anteriore. FaxLine Intero Utilizzare questo parametro per richiedere che il fax venga inviato tramite una determinata linea fax. Specificare il numero della linea fax come configurato in Configurazione di GFI FaxMaker. Demandline Bool Quando si indica una linea fax specifica (attributo FaxLine), se la linea è occupata o non è disponibile, il fax viene inviato usando un'altra linea. Per inviare il fax unicamente da una linea particolare, impostare il valore dell attributo su true. header Immettere un'intestazione personalizzata aggiunta a quella all'inizio del fax. UniqueID Specifica un identificatore che viene utilizzato per contrassegnare il messaggio. L'univocità dell'identificatore è stabilita dall'autore del messaggio. TextAPI Specifica una singola riga del comando API di testo. Per un elenco dei comandi di API di testo, fare riferimento a Comandi API di testo MessageBodyFile. FileData Un instanza di FileData, contenente un file di testo con il corpo messaggio del fax. Attachments List<FileData> Matrice di allegati FMUser Un utente API Web. Membri dati L indirizzo di posta elettronica dell utente configurato nel nodo Utenti con licenza di Configurazione di GFI FaxMaker. L utente deve essere un utente registrato API Web. Password In Active Directory, questa è la password dell utente configurato. Negli ambienti SMTP la password è una GUID generata in automatico, disponibile dal nodo Utenti con licenza di Configurazione di GFI FaxMaker per gli utenti API Web registrati. GFI FaxMaker 4 API servizio Web 32

33 4.4.4 FaxJobID GFI FaxMaker assegna un identificatore univoco a ciascun destinatario di un fax in uscita. Utilizzare questo identificatore per monitorare lo stato di un fax. Membri dati Recipient Il numero di fax del destinatario. ID L identificatore univoco assegnato da GFI FaxMaker ReceivedFaxDetails Un oggetto di questa classe viene ricevuto quando si chiama GetNextFax(). Membri dati FaxUID Identificatore univoco del fax. Utilizzare l identificatore per l eliminazione di un fax. WhenReceived DateTime Data e ora di ricezione del fax. NosPages Numero di pagine ricevute. Resolution FaxResolution La risoluzione del fax ricevuto. RemoteID Il nome del fax del mittente. DTMF_DID Il numero di estensione DTMF/DID della linea di ricezione FileData Un oggetto di questa classe contiene i dati effettivi di un file. Membri dati Nome del file Il nome file del file, principalmente utilizzato per determinarne il formato. Data Byte[] I dati del file in una matrice di byte FaxSendingStatus Un oggetto di questa classe viene restituito quando si chiama GetSendingFaxStatusUpdates(). Membri dati FaxUID Identificatore univoco del fax. RemoteID Il nome del fax del mittente. CurrentTransmissionPage Intero La pagina che è in fase di trasmissione. Dopo aver inviato un fax, questo restituisce il numero totale di pagine trasmesse. TotalPages Intero Il numero totale di pagine che costituiscono il fax. Status SendingStatus Lo stato attuale del fax. 4.5 Enums FaxPriority Valore None Low Normal High VeryHigh Nessuna priorità specificata. Priorità bassa. Priorità normale. Priorità alta. Priorità molto alta. GFI FaxMaker 4 API servizio Web 33

34 4.5.2 FaxResolution Valore NonSet High Normal Non è stata specificata nesuna risoluzione fax personalizzata. Alta risoluzione. Risoluzione normale fax SearchCriteria Valore RemoteID DTMF Ricerca i fax per ID chiamante o per nome fax. Cerca i fax per numero di estensione della linea di ricezione SendingStatus Valore Preparing ConvertingAttachment Pending Sending Sent Failed Cancelled Elaborazione e conversione del contenuto in fax. Convertirà l allegato nel formato fax. Il fax è in coda, pronto per essere inviato. Il fax è in trasmissione. Il fax è stato inviato. Trasmissione non riuscita. L operazione del fax è stata annullata FMResult Valore Success Failure UserNotValid DBError FaxImageNotFound NoSender NoRecipients InvalidFaxDescription Funzione completata con successo. Funzione non riuscita. Dati utente non validi. Errore di scrittura o lettura dal database. L immagine fax richiesta non è stata rilevata. Non è stato specificato nessun mittente o mittente non valido. Non è stato specificato nessun destinatario o destinatario non valido. Uno o più campi obbligatori non compilati. Per aiuto nello sviluppo di applicazioni personalizzate per API Servizi Web di GFI FaxMaker, fare riferimento agli esempi forniti. di Java: di C#: Gestione coda API servizio Web Quando un fax viene inoltrato a un utente registrato di API Servizio Web, GFI FaxMaker salva il fax nella coda di API Servizio Web. GFI FaxMaker 4 API servizio Web 34

35 Utilizzare le varie funzioni documentate in API Servizio Web per recuperare i fax dalla coda. Quando si recupera un fax, non viene automaticamente eliminato dalla coda. Chiamare DeleteFax() per eliminarlo Fax scaduti nella coda I fax ricevuti vengono salvati nella coda di API Servizio Web per 30 giorni. Se superano i 30 giorni, i fax vengono spostati automaticamente dalla coda e non possono essere recuperati dall API Servizio Web. Per impostazione predefinita, i fax scaduti vengono spostati nella seguente cartella: <cartella di installazione di GFI FaxMaker>/WSAPI/Retention/ Per ciascun fax spostato in questa cartella, GFI FaxMaker salva l immagine del fax nel formato.fax (può essere aperto con un visualizzatore immagini) e un file contenente i metadati del fax. Per modificare la cartella predefinita: 1. Arrestare tutti i servizi di GFI FaxMaker. 2. Accedere alla cartella di installazione di GFI FaxMaker. 3. Aprire il file ML.Svc.Attendant.exe.config in un editor di testo. 4. Individuare la chiave RetentionFolder e modificarne il valore con il nuovo percorso. 5. Avviare i servizi arrestati durante il passaggio 1. NOTA Adottare cautela per la modifica dei file di installazione del software. Un errata configurazione può causare problemi nella funzionalità del prodotto. GFI FaxMaker 4 API servizio Web 35