📗 API: Obtén tu Libreta de Clientes
Acceder a todos los clientes que se han comunicado contigo a través de Adereso.
Obtén todos tus clientes, rápido y fácil
¿Necesitas sincronizar los contactos de Adereso con tu CRM, data warehouse o sistema externo? ¡Ahora es posible! Con la nueva Contact Book API v2 puedes:
- 🔄 Sincronizar contactos de forma incremental
- ⚡ Consultas ultrarrápidas gracias a índices optimizados
- 📊 Integrar con pipelines de datos sin sobrecargar el sistema
🛠 ¿Cómo utilizar la API de Clientes?
Paso 1: Obtén tu Token de Autenticación
Antes de hacer cualquier llamada, necesitas tu Token de Establishment.
- Ve a Administrador → Usuarios de API
- Copia tu Token de Acceso
- Úsalo en el header de cada petición:
Authorization: Bearer TU_TOKEN_AQUI📸 Token de API disponible en Administrador → Usuarios de API
2. Consulta tu Lista de Contactos
Usa la siguiente URL para obtener tus contactos:
curl -X GET "https://api.adereso.cl/api/external/v2/contacts/" \
-H "Authorization: Key TU_API_TOKEN"💡 Tip: La respuesta viene paginada (50 contactos por página por defecto)
3. Filtra por Fecha para Cargas Incrementales
Para obtener solo los contactos activos desde una fecha específica:
curl -X GET "https://api.adereso.cl/api/external/v2/contacts/?last_message_from=2024-12-01&order_by=last_message_desc" \
-H "Authorization: Key TU_API_TOKEN"💡 Esto es ideal para sincronizaciones diarias. Solo traes los contactos que tuvieron actividad desde la última vez.
4. Obtén el Detalle de un Contacto Específico
curl -X GET "https://api.adereso.cl/api/external/v2/contacts/507f1f77bcf86cd799439011/" \
-H "Authorization: Key TU_API_TOKEN"🔢 Límites y Restricciones
Parámetro | Límite | Descripción |
page | Debe ser ≥ 1 | Número de página (no acepta 0 o negativos) |
page_size | 50 | Contactos por página (fijo) |
Formato de fecha | YYYY-MM-DD o YYYY-MM-DDTHH:MM:SS | Para filtros last_message_from/to |
🔧 Opciones de Ordenamiento
Valor | Descripción | Ideal para |
uname_asc | Ordenar por nombre A-Z | Reportes alfabéticos |
uname_desc | Ordenar por nombre Z-A | Reportes alfabéticos inversos |
last_message_asc | Mensajes más antiguos primero | Análisis histórico |
last_message_desc | Mensajes más recientes primero (default) | Sincronizaciones incrementales |
👥 ¿Quién tiene acceso?
Esta API requiere un API Token válido del establecimiento. Solo usuarios con rol de Administrador pueden generar tokens.
🛑 Zona de Peligro: Lee esto antes de usar tu API
No compartas tu API Token
Cualquiera con el token puede acceder a tu libreta de contactos completa.
Usa filtros de fecha
Consultar todos los contactos sin filtros puede ser lento para establecimientos con miles de contactos.
🔧 Solución de Problemas
Error 400: "Invalid order_by parameter”
⚠️ El problema: El orden no es correcto.
✅ La solución: Usa uno de los valores válidos
uname_asc,uname_desc,last_message_asc,last_message_desc
Error 400: "Invalid page parameter”
⚠️ El problema: El número de página no es valido
✅ La solución: El número de página debe ser 1 o mayor.
Error 400: "Invalid date format”
⚠️ El problema: El formato de la fecha que ingresaste no es correcto
✅ La solución: Usa formato YYYY-MM-DD o YYYY-MM-DDTHH:MM:SS
Error 401: Unauthorized
⚠️ El problema: Tu API Token no es correcto o no está vigente
✅ La solución: Verifica que tu API Token sea correcto y esté vigente. Intenta copiarlo nuevamente desde Administrador > Usuarios de API
📂 Glosario de Términos
Término | Definición |
last_message | Fecha del último mensaje intercambiado con el contacto. Ideal para detectar actividad reciente. |
updated_at | Fecha de última modificación de los datos del contacto. Ideal para detectar cambios en metadatos (nombre, email, etc.) |
sn | Red social del contacto (whatsapp, facebook, instagram, etc.) |
optin | Estado de consentimiento del contacto para recibir mensajes proactivos |
ticket_count | Cantidad de casos/tickets asociados al contacto |
🧪 Pruébalo ahora (Quick Win)
- Abre tu terminal
- Reemplaza
TU_API_TOKENcon tu token real
- Ejecuta:
curl -X GET "https://api.adereso.cl/api/external/v2/contacts/?page=1" \
-H "Authorization: Key TU_API_TOKEN"- ¡Deberías ver tus primeros 50 contactos! 🎉
📊 Ejemplo de Respuesta
{
"status": 200,
"pagination": {
"page": 1,
"pages": 10,
"total_elements": 150,
"page_size": 50
},
"data": [
{
"_id": "507f1f77bcf86cd799439011",
"name": "Juan Pérez",
"username": "juanperez",
"uid": "56912345678",
"sn": "whatsapp",
"email": "juan@example.com",
"phone": ["+56912345678"],
"last_message": "2024-12-01T14:22:33",
"updated_at": "2024-12-01T14:22:33",
"ticket_count": 5
}
]
}👋🏻 Podría interesarte
API: Obtener fotos, videos y documentos Acceder a todas las fotos, videos y documentos que tus clientes envían en sus conversaciones, sin tener que buscarlos uno por uno.
Módulo de Clientes Base de datos inteligente que consolida toda la información relevante de tus clientes en un solo lugar
¿Tienes dudas sobre cómo usar el API?
Contáctanos en soporte@adereso.com, vía chat, al WhatsApp +56953851610 o al email soporte@adere.so.