Web Services API - LogicalDOC Documentation

API Web Services

LogicalDOC può essere usato come middleware e può essere integrato con altri sistemi con l'uso dei Web Services incorporati. Il modulo Web Service è parte della distribuzione di base di LogicalDOC ed è conforme alle specifiche del W3C SOAP e MTOM. Utilizzando SOAP su HTTP consente una più facile comunicazione attraverso proxy e firewall rispetto alle precedenti tecnologie esecuzione remota. MTOM è un metodo di trasmissione efficiente per i dati binari da e verso servizi web; permette l'invio più efficiente di dati binari in una richiesta SOAP o una risposta.

LogicalDOC supporta anche lo standard più informale chiamato RESTful.

I Servizi Web di LogicalDOC sono suddivisi in una serie di servizi specializzati, ognuno dedicato ad un argomento specifico.

API Key

Per comunicare con i Web Services, devi prima generare un' API Key: questa serve ad autenticare il tuo client. Leggi di più qui.

Esempi di Web Services

Il modo più semplice per interfacciarsi con le API di LogicalDOC è quello di utilizzare uno dei nostri programmi ed esempi che forniamo nella pagina wiki del prodotto. In quella pagina forniamo progetti di codice sorgente in tutte i principali linguaggi di programmazione: Java, .NET, PHP, Python. Essi possono essere un buon esempio per imparare in fretta come interfacciarsi con le API di LogicalDOC.

Documentazione dei Web Services

SOAP


Release	Documentation	Compatiblity with previous releases
9.2.1	soapdoc	9.2
9.2	soapdoc	9.1.1, 8.8
9.1.1	soapdoc	9.1, 8.9.3
9.1	soapdoc	9.0
9.0	soapdoc	8.9.3
8.9.3	soapdoc	8.9.2
8.9.2	soapdoc	8.9.1, 8.9
8.9.1	soapdoc	8.9
8.9	soapdoc
8.8.6	soapdoc
8.8.5	soapdoc
8.8.4	soapdoc
8.8.3	soapdoc
8.8.2	soapdoc
8.8.1	soapdoc
8.8	soapdoc
8.7.4	soapdoc
8.7.3	soapdoc
8.7.2	soapdoc
8.7.1	soapdoc

REST


Release	Documentation	Compatiblity with previous releases
9.2.1	restdoc	9.2
9.2		9.1.1, 8.8
9.1.1	restdoc	9.1, 8.9.3
8.9.3	restdoc	8.9.2
8.9.2	restdoc	8.9.1, 8.9
8.9.1	restdoc	8.9
8.8.4	restdoc
8.8.3	restdoc
8.8.1	restdoc
8.7.4	restdoc
8.6.0	restdoc
8.4.2	restdoc
8.3.4	restdoc
8.1	restdoc

API Keys

Una API Key è una semplice stringa crittografata che puoi usare quando chiami le API di LogicalDOC.

Ogni utente può generare più API Keys e ciascuna può essere usata da un'applicazione esterna per connettersi a LogicalDOC a nome di quell'utente. Questo è più sicuro rispetto all'uso diretto delle credenziali dell'utente e dalla versione 9.0 l'autenticazione delle credenziali legacy è stata deprecata a favore della nuova autenticazione dell'API Key.

Creare un' API Key

Apri il menu Account > Sicurezza > API Keys.

Qui clicca su Crea nuova API Key, Ti verrà chiesto di dare un nome alla nuova chiave, quindi digita il nome e conferma.

Copia subito il codice in un luogo sicuro perché non potrai più vederlo in seguito.

Puoi quindi inserire questa chiave generata nella tua applicazione in modo che possa connettersi a LogicalDOC.

Mantenere in sicurezza un' API key

Quando utilizzi le API Keys nelle tue applicazioni, assicurati che siano protette sia durante l'archiviazione che durante la trasmissione. L'esposizione pubblica delle tue credenziali può compromettere il tuo account, il che potrebbe comportare addebiti imprevisti sul tuo account. Per contribuire a proteggere le tue API Keys, segui queste best practice:

Non incorporare le API Keys direttamente nel codice. Le API Keys incorporate nel codice possono essere accidentalmente esposte al pubblico. Ad esempio, potresti dimenticare di rimuovere le chiavi dal codice che condividi. Invece di incorporare le tue API Keys nelle tue applicazioni, archiviale in variabili di ambiente o in file esterni all'albero sorgente della tua applicazione.

Non condividere la stessa API Key tra più applicazioni, ad esempio non utilizzare la stessa chiave per i componenti aggiuntivi di Office ma creare una API Key per il componente aggiuntivo di Office e una chiave diversa per il componente aggiuntivo di Outlook.

Elimina le API Keys non necessarie per ridurre al minimo l'esposizione agli attacchi.

Rivedi il tuo codice prima di rilasciarlo pubblicamente. Assicurati che il tuo codice non contenga API Keys o altre informazioni private prima di renderlo disponibile al pubblico.