API de Sistema QrBuho
La API de QrBuho ofrece un conjunto de endpoints que permiten interactuar con el sistema de generación y gestión de códigos QR, el envío de mensajes masivos y la transferencia de archivos a través de WhatsApp. A continuación, se detallan los principales archivos y sus respectivas funcionalidades.
URL para integración: Dirección que debe utilizarse para la conexión con la API del sistema, es la direccion de la url del sistema.
Ejemplo de URL: https://demo.qr.uio.la
1. Enviar PDF por WhatsApp
Este endpoint permite enviar archivos PDF a un número de WhatsApp en formato Base64. Se requiere proporcionar el número de teléfono en formato internacional, un mensaje acompañante y el archivo PDF que se desea enviar. Esta funcionalidad es útil para la automatización del envío de documentos directamente a través de WhatsApp.
- Método:
POST - Path:
/api/message/send/pdf - Parámetros:
number: Número de teléfono en formato internacional sin el "+".message: Mensaje de texto que acompañará el archivo PDF.file: Archivo PDF en formato Base64.filename: Nombre del archivo PDF.
2. Enviar Mensajes Masivos
El endpoint de mensajería masiva está diseñado para enviar mensajes de texto, archivos multimedia, o enlaces a un grupo grande de destinatarios en WhatsApp. Este endpoint es fundamental para la automatización y gestión de campañas de marketing, promociones o comunicaciones en masa.
- Método:
POST - Path:
/api/message/send/mass - Parámetros:
message: El contenido del mensaje a enviar.file: Archivo multimedia a adjuntar (opcional).contacts: Lista de números de teléfono de los destinatarios.
3. Generación de Códigos QR
La API también incluye funcionalidades para generar códigos QR, lo que es esencial para crear enlaces rápidos hacia sitios web, páginas de pago, o sistemas de autenticación. El endpoint permite generar códigos QR personalizados a partir de diferentes tipos de datos, como URLs, texto, o incluso información de contacto.
- Método:
POST - Path:
/api/qr/generate - Parámetros:
data: El contenido que se desea convertir en un código QR.type: El tipo de contenido (por ejemplo, URL, texto, contacto).size: Tamaño del código QR generado.
Cada uno de estos endpoints está diseñado para facilitar la integración con otros sistemas y la automatización de tareas en la plataforma QrBuho, lo que permite optimizar la gestión de mensajes y códigos QR de manera eficiente y escalable.
Authentication
- HTTP: Bearer Auth
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | JWT |