Servicios web básicos de Athento ECM

A continuación se describen operaciones básicas mediante la API del gestor documental que pueden ser útiles para realizar integraciones con el mismo:

 

Autenticación y cabeceras

Para autenticar los servicios descritos a continuación es necesario establecer el usuario y contraseña que serán incluidas mediante BasicAuthentication en las cabeceras de la petición.

 

Ejemplo en el cliente POSTMAN para Chrome:

 

Además, para poder realizar correctamente todas las peticiones a servicios, es necesario introducir la siguiente cabecera:

Content-Type: application/json+nxrequest

 

Ejemplo en el cliente POSTMAN para Chrome:

 

Ejemplo de petición autenticada con la cabecera:

 

 

Consultar los tipos documentales disponibles en el sistema

 

 

El servicio nos devolverá una respuesta como la que sigue:

 

Obtener el tipo documental de un documento

Este servicio nos devuelve toda la información de estructura con contenido de un documento existente en el sistema dado su identificador.

 

El servicio nos dará una respuesta como la que sigue:

 

Dentro de las etiquetas <type></type> se encuentra el tipo documental del documento consultado.

Obtener los metadatos para un tipo documental concreto

Este servicio nos devuelve la estructura de metadatos y facetas de un tipo documental concreto.

El servicio nos devolverá una respuesta como la que sigue:

Los metadatos pueden hacer parte de diferentes esquemas (schemas), por ejemplo, en el código anterior, pueden verse los metadatos del tipo "PaymentOrder" dentr del esquema "fields".

Obtener un documento

Existen dos mecanismos básicos:

A) Por su Id

B) Por su path

Obtener el preview de un documento

 

 

Eliminar un documento

 

Tras la llamada, el sistema deberá dar una respuesta como la siguiente:

Crear un documento

El siguiente servicio web crea un nuevo documento con su título.

Tras la llamada, el sistema deberá dar una respuesta como la siguiente:

 

Actualizar un documento

 

 

Hacer consultas

 

A continuación un ejemplo:

Con el cliente como POSTMAN, una llamada como la anterior nos daría una respuesta similar a la quue sigue:

Vemos que el sistema ha encontrado dos documentos cuyo título es "ATHENTO" y nos ha devuelto sus propiedades.

Más Operaciones