Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

 

Info
titleConsideraciones previas

$ATHENTO_HOST es el valor del dominio donde se encuentra desplegada la instancia de Athento ECM.

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:

Image Added

 

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:

Image Added

 

Ejemplo de petición autenticada con la cabecera:

Image Added

 

 

Consultar los tipos documentales disponibles en el sistema

...

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.

Code Block
titleTipo documental de un documento
http://$ATHENTO_HOST/nuxeo/restAPI/default/{docId}/export?format=XML

...

Obtener los metadatos para un tipo documental concreto

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

Code Block
titleMetadatos de un tipo documental
http://$ATHENTO_HOST/nuxeo/api/v1/config/types/{docType}

...

Code Block
titlePor su Path
http://$ATHENTO_HOST/nuxeo/api/v1/idpath/{docPath}
Info
titleImportante

Debes utilizar el path a partir de /default/

Obtener el preview de un documento

...

Tip
titleManual de la API de Athento

Para mayor información, te recomendamos descargar el manual de la API de Athento, disponible desde:

 http://go.athento.com/athento-ecm-api-guide