Nombre de la Categoría: > API'S

API de Carga – Archivos Adjuntos

A continuación se presenta la descripción de un servicio REST que permite cargar individualmente archivos para luego ser adjuntados dinámicamente por contacto.

Es frecuente utilizar este servicio cuando se desea enviar un archivo distinto a cada contacto. Como por ejemplo: un estado de cuenta, una factura o una carta personalizada.

Normalmente este servicio es utilizado en conjunto con el Webservice de activación de conversaciones, ya que algunas conversaciones son configuradas para enviar archivos adjuntos dinámicos por contactos, y esos archivos deben ser cargados previamente.

Los archivos cargados a través de este servicio son almacenados en un contenedos de documentos digitales durante 7 días, tiempo durante el cual documento debe ser enviado a como archivo adjunto.

  • Acceso

Protocolo URL
HTTP
https://appserv.danaconnect.com/dana/conversation/http/rest/file/upload

 

  • ¿Cómo empezar a utilizar el Web Service?

  1. La compañía que va a utilizar el Web Service debe contar con un usuario y contraseña válidos.
  2. Por motivos de seguridad, el usuario que va a utilizar el Web Service debe contar con un permiso especial para el uso de las APIs de DANA.

 

  • Autenticación

Para poder acceder a los métodos de este API es necesario tener credenciales válidas. Se utiliza un método de autenticación BASIC para el acceso a los WebServices basado en un login y password.

Login: El login consiste en el nombre de usuario concatenado con un @ y seguido del código de la compañía.

 

  • Funcionamiento

Para cargar un archivo en el contenedor de documentos solo en necesario invocar desde un cliente HTTP el URL:

https://appserv.danaconnect.com/dana/conversation/http/rest/file/upload

Parámetros

Utilizar el método POST (multipart) para enviar el siguiente parámetro:

file: Es el archivo que se desea cargar en el contenedor de documentos

Respuesta

La respuesta del servicio es un XML con las siguientes etiquetas:

  • fileID: Es el ID del archivo en el contenedor de documentos. Este identificador es el parámetro que se utilizará como referencia para adjuntar los archivos en los correos.
  • finaName: Es el nombre original del archivo.
  • idCompany: Es el código de la compañía en DANAConnect a la cual se asoció el documento.

 

Ejemplo de respuesta:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<result>
<fileID>mdb://3749f084c9d320cda239a11abea6ahf7</fileID>
<fileName>FileTest.pdf</fileName>
<idCompany>demodana</idCompany>
</result>

En caso de que ocurra un error, las respuestas serán:

400 = Error cargango el archivo en el contenedor de documentos
409 = Argumento incorrecto
401 = Acceso no autorizado

 

 

Enviando los archivos adjuntos:

Una vez cargados los archivos en el contenedor de documentos, es posible enviarlos como archivos adjuntos.

Para realizar esto es necesario crear una conversación con un nodo de email que tenga seleccionada la opción de envío de archivo dinámico.

Esto se puede hacer haciendo clic sobre el botón de clip que se ubica a la derecha del título del correo:

DANA-DynamicFileTag

Así se selecciona el soporte para archivos dinámicos por contacto.

DANA-ArchivoAdjunto

En el ejemplo de arriba se puede observar la creación de una etiqueta llamada Archivo_119934. Este es el nombre del campo que debe ser mapeado con el fileID retornado por el servicio de carga de documentos.

DANA-FieldMappingDynamicFile


Ver Tambien:
« | »