La API de Zenvia Customer Cloud ofrece funcionalidades que permiten consultar información de anexos directamente mediante solicitudes HTTP. Con esta API, es posible integrar y descargar los anexos en tu sistema, automatizando consultas y recuperando archivos específicos.
Administración de APIs
Para utilizar la API, es necesario obtener un Token de Autenticación, que debe enviarse en todas las solicitudes mediante el encabezado. Este token puede generarse en el panel de control de Atención de soporte - Enterprise, siguiendo los pasos a continuación:
- Accede al menú Configuraciones.
- Ve a Cuenta > Parámetros.
- En la pestaña Entorno, desplázate hasta el final de la página para encontrar el Token. Copia la clave proporcionada.
Este token debe tratarse como una clave de seguridad, evitando comparticiones no autorizadas.
Además del Token de Autenticación, será necesario el Hash de algún archivo, que puede obtenerse utilizando otras APIs del sistema, como la API de tickets.
Con la clave de autenticación y el Hash en mano, selecciona una herramienta para probar la API. Recomendamos el uso de Postman, un software ampliamente utilizado para probar y manipular APIs fácilmente.
Paso a paso para pruebas en Postman
- Abre Postman y crea una nueva solicitud.
- En el campo de URL, ingresa el endpoint de la API que deseas consultar. Por ejemplo, para listar un anexo, utiliza el siguiente endpoint:
https://api.movidesk.com/public/v1/storage/download?token=TOKEN&id=HASH - Pega la clave del Token en el campo correspondiente a Token.
- Pega el Hash en el campo ID, obtenido a partir de la consulta previa de APIs.
- Selecciona el método HTTP adecuado, en este caso, GET.
- Haz clic en Send para enviar la solicitud a la API.
Límites y seguridad
La API tiene un límite de 10 solicitudes por minuto para garantizar un rendimiento estable. Si tu escenario requiere un mayor volumen de solicitudes, contacta al soporte técnico para analizar la viabilidad. Para más información, consulta la documentación oficial sobre horarios y límites de las APIs.
Integración con la API: Descargar un anexo
La descarga de un anexo específico puede realizarse a través de su ID (Hash). El endpoint para esta operación es:
- URL: /public/v1/storage/download?token=TOKEN&id=HASH
- Método: GET
Propiedad | Tipo | Descripción |
token | string | Token del sistema |
id | string | Hash identificador del anexo |
Ejemplo de solicitud en Postman:
GET
https://api.movidesk.com/public/v1/storage/download?token=88888888-8888-8888-8888-888888888888&id=44444444444444444444444444444444
Esta solicitud devolverá el archivo adjunto correspondiente al ID proporcionado. Si el formato del archivo adjunto es compatible con Postman, el contenido se mostrará en una vista previa.
Ejemplos de Respuesta
- Si el ID no se encuentra o el Token es inválido:
- Respuesta: HTTP Status 404.
- Si el ID se encuentra con éxito:
- Respuesta: HTTP Status 200.
- El archivo será enviado en el formato correspondiente con el Content-Type adecuado para su descarga.