Web Services API - LogicalDOC Documentation

API Web Services

LogicalDOC se puede utilizar como middleware y se puede integrar con otros sistemas por el uso del servicio web integrado. El módulo Web Services es parte de la distribución de LogicalDOC y es compatible con las especificaciones de W3C SOAP. Utilizando SOAP sobre HTTP permite una comunicación más fácil a través de servidores proxy y firewall que la tecnología de ejecución remota anterior. MTOM es un método de envío eficiente para los datos binarios desde y hacia los servicios web; eso permite un envío más eficiente de datos binarios en una petición o respuesta SOAP.

LogicalDOC también es compatible con un estándar más informal llamado REST. Los Servicios Web LogicalDOC se dividen en una serie de servicios especializados, cada uno dedicado a un tema específico.

API Key

Para poder llamar a los servicios web, primero debe generar un API Key: esa se utiliza para autenticar a su client. Lea más aquí.

Servicios Web y Ejemplos

La forma más fácil de interactuar con el API de LogicalDOC es mediante el uso de uno de nuestros programas y ejemplos que proporcionamos en la página wiki del producto. En esa página proporcionamos proyectos de código fuente en los principales lenguajes de programación: Java, .NET, PHP, Python. Pueden ser unos buenos ejemplos para aprender rápidamente la forma de interactuar con el API de LogicalDOC

Documentación de los Servicios Web

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 clave API es una cadena cifrada simple que puede utilizar al llamar a las API de LogicalDOC.

Cada usuario puede generar varias claves API, y cada una de ellas puede ser utilizada por una aplicación externa para conectarse a LogicalDOC en nombre de ese usuario. Esto es más seguro en comparación con el uso directo de las credenciales del usuario y, desde la versión 9.0, la autenticación de credenciales heredadas ha quedado obsoleta en favor de la nueva autenticación de clave API.

Crear una API key

Open the menu Cuenta > Seguridad > API Keys.

Aquí haga clic en Crear nueva API key. Se le pedirá que le dé un nombre a la nueva clave, así que escriba el nombre y confirme.

Copia inmediatamente el código en un lugar seguro porque no podrás volver a verlo.

Luego puedes colocar esta clave generada en tu aplicación para que pueda conectarse a LogicalDOC.

Cómo proteger una API key

Cuando utilice claves API en sus aplicaciones, asegúrese de que se mantengan seguras durante el almacenamiento y la transmisión. Si expone sus credenciales públicamente, su cuenta puede verse comprometida, lo que podría generar cargos inesperados en su cuenta. Para ayudar a mantener seguras sus claves API, siga estas prácticas recomendadas:

No incorpore claves API directamente en el código. Las claves API que están incorporadas en el código pueden exponerse al público accidentalmente. Por ejemplo, puede olvidar eliminar las claves del código que comparte. En lugar de incorporar sus claves API en sus aplicaciones, almacénelas en variables de entorno o en archivos fuera del árbol de origen de su aplicación.

No comparta la misma clave API entre varias aplicaciones; por ejemplo, no utilice la misma clave para los complementos de Office, sino que cree una clave API para el complemento de Office y una clave diferente para el complemento de Outlook.

Elimine las claves API innecesarias para minimizar la exposición a ataques.

Revise su código antes de publicarlo. Asegúrese de que su código no contenga claves API ni ninguna otra información privada antes de ponerlo a disposición del público.