Especificaciones OpenAPI:

Puede encontrar toda la documentación y especificaciones bajo el estándar OpenAPI en nuestro portal de desarrolladores: https://dev.danaconnect.com

API REST - Document Manager

El API REST Document Manager es un servicio web que permite la administración, indexación, consulta, compresión y descarga de archivos de documentos asociados a un registro de una lista de contacto y posibilita además luego activar un flujo de conversación en DANAConnect utilizando dicha data.

Con este servicio es posible:

1. Consultar documentos almacenados en el repositorio usando filtros y tipos de archivo, previamente configurados desde la interfaz del Document Manager en la plataforma DANAConnect
2. Integración con envíos desde la plataforma DANAConnect mediante la activación de una conversación
3. Obtener las bitácoras históricas de descargas
4. Realizar la compresión de una carpeta del Document Storage, o varias carpetas o varios archivos
5. Obtener URL Cortos o URL Largos para poder realizar descargas de documentos de forma segura

URL Base:

Todos los URLs referentes a esta API tiene la siguiente base:

Protocolo: HTTPS

URL

Web Service
https://api.danaconnect.com/document/1.0/

Autenticación al API

EL API utiliza el mismo sistema de credenciales de usuarios DANAConnect.

Se utiliza el método de autenticación HTTP BASIC AUTH, el cual está basado en un login y password.

Credenciales:

Login : consiste en el nombre de usuario de DANAConnect concatenado con un @ y seguido del código de la compañía (IDCompany) en DANAConnect.
Password : es el que corresponde a ese usuario en DANAConnect

Ejemplo:

Nombre de usuario: jperez
Código de compañía: loremipsumcompany
Login para el API: jperez@loremipsumcompany

Autenticación:

El método HTTP Basic Auth es el más común para autenticarse desde clientes REST:

Consideraciones previas a utilizar el API:

1. La empresa que va utilizar el API debe contar con un usuario y contraseña válidos.
2. Por motivos de seguridad, el usuario que va a utilizar el API deber contar con un permiso especial. El administrador de su cuenta DANAConnect debe asegurarse de que este permiso esté habilitado.
3. Esta API funciona sobre Conversaciones que previamente se hayan creado y estén activas. Esto significa que debe tener el ID de Conversación (conversaciónID).
   **Número de identificación de la conversación (idConversation: **)El número de identificación de la conversación en DANAConnect se puede encontrar en la página de reportes de la activación.

4. Se debe haber configurado previamente los tipos de archivos para la indexación y filtrado de los criterios de búsqueda de sus documentos en el Document Manager de la plataforma DANAConnect.
5. Se debe tener una cuenta con un repositorio de documentos activo de Document Storage en DANAConnect.

Servicio GetUrlDownload – Obtener el URL

Servicio para solicitud del URL para la descarga del documento.

**URL: **

https://api.danaconnect.com/document/1.0/geturldownload

**METODO **

POST

Descripción de Parámetros de Entrada del servicio geturldownload

Descripción de Parámetros de la lista de archivos DocumentListJson

Descripción de Parámetros de salida ResponseGetUrlDownloadListJSON

Descripción de Parámetros de salida ValidStorageJson

Ejemplo del servicio GetUrlDownload:

Request

{

"configServiceType": 1, "isStrict": false, "isZip": false, "urlType": 1, "documentList": [

{

"url": "s3://demos/SolicitudDocs/Poliza10-987654321.pdf"

}

],

"filter1":"88",

"filter2":"Demo",

"filter3":"2021"

}

Response

{

"codResponse":"00",

"desResponse":"OK", "result": [

{

"isObjectExist": true, "urllong": null,

"urlshort": "https://api.danaconnect.com/document/download?id=1501af6f4096", "url": "s3://demos/SolicitudDocs/Poliza10-987654321.pdf"

}

]

}

Servicio GetURLDownloadWithConversation – Obtener el URL e iniciar conversación

Servicio para solicitud del URL para la descarga del documento e inicio de una conversación.

URL

https://api.danaconnect.com/document/1.0/geturldownloadwithconversation

METODO

POST

Descripción de Parámetros de Entrada del Servicio URLDownloadWithConversation

https://help.danaconnect.com/es/editar-campo/

Descripción de Parámetros de la lista de archivos DocumentListJson para GetURLDownloadWithConversation

Método relacionado GetURLDownloadWithConversation

Descripción de Parámetros de salida GetURLDownloadWithConversationJason

Método relacionado GetURLDownloadWithConversation

Descripción de Parámetros de salida ValidStorageJson

Método relacionado GetURLDownloadWithConversation

Ejemplo del servicio GetURLDownloadWithConversation:

Request

{

"configServiceType": 1,

"isStrict": false,

"isZip": false,

"urlType": 1,

"documentList": [

{

"url": "s3://demos/SolicitudDocs/Poliza10-987654321.pdf"

}

],

"idConversation":"165245",

"values": {

"MYDB_NAME" : "Luis",

"MYDB_LASTNAME" : "Lopez",

"MYDB_EMAIL" : "luis.lopez@dominio.com",

"MYDB_URLSHORT" : "$f{URLSHORT}",

}

}

Response

{

"codResponse" : "OO",

"desResponse" : "OK"

}

Servicio GetURLDocumentsbyFilters – Buscar por filtros

Servicio para solicitud del URL para la búsqueda de documentos basada en filtros y descarga del documento

URL

https://api.danaconnect.com/document/1.0/getdocumentbyfilters

METODO

POST

Descripción de Parámetros de Entrada del servicio GetURLDocumentsbyFilters

Descripción de Parámetros de la lista de archivos DocumentListJson para GetURLDocumentsbyFilters

Método relacionado GetURLDocumentsbyFilters

Descripción de Parámetros de salida ResponseGetDocumentListJSON

Método relacionado GetURLDocumentsbyFilters

Descripción de Parámetros de salida GetDocumentListJSON

Método relacionado GetURLDocumentsbyFilters

Ejemplo de servicio GetURLDocumentsbyFilters

Request

{

"id_document_type": 0,

"type_filter_1": "equal",

"filter_1": "Test Apellido",

"type_filter_2": "equal",

"filter_2": "Test Apellido",

"type_filter_3": "equal",

"filter_3": "Test Apellido",

"conditional":"or"

}

Response

{

"responseCode": "00", "responseDescription": "Success", "documentlist": [

{

"id_document": 2, "document_type": "TestAPIs",

"path_document_storage": "s3://zip/3e365247.zip",

"url_short": "https://edocument-platform.com/document/download?id=afffbf065855", "url_long": "",

"url_valid_until_date": "2019-07-27", "iszip": false,

"filter_1": "Test Apellido", "filter_2": "Test Nombre",
"filter_3": "test@test.com", "create_date": "2019-07-25"

}

]

}

Descripción de Errores del API

00 – OK

000 – OK warning – OK con alerta

01 – Unauthorized user. Access denied. – Usuario no autorizado

02 – Bad Parametrer – Parametro errado

03 – Exceeded the maximum of documents allowed – Excedió el número de documentos permitido

04 – Document not found – Documento no encontrado

05 – URL type not found – Tipo de documento no encontrado

06 – Unknown error – Error desconocido

07 – Duplicated URL on list of documents – El URL está duplicado

08 – You did not send a special tag $f{URLSHORT} or $f{URLLONG} associated with the urlType. No envió una etiqueta especial $ f {URLSHORT} o $ f {URLLONG} asociada con urlType. –

09 – It exceeded the maximum number or files to be compressed

10 – The configuration service type is not correct or does not belong – La configuración del tipo de servicio no corresponde

11 – The configuration service type is not complete (code Filter) – La configuración del tipo de servicio no está completa (código de filtro)

12 – It is required to include the labels configured to filter – Se requiere incluir las etiquetas configuradas para filtrar

13 – Error: You must choose at least one option as filter – Se debe elegir al menos una opción como filtro

14 – Error: You must put in filter types (none | equal | contains | begins | ends) – Error: Debe poner en tipos de filtro (none | equal | contains | begins | ends)

15 – Error: You must put in conditional types (and | or) – Error: Debe poner tipos condicionales (and | or)

Actualizado el: 14/12/2021