Para obtener la lista de usuarios que han interactuado con Vivo Recuerdo existen dos métodos: filtrando por id de servicio o por fechas.
Para obtener la lista de usuarios de un servicio, es necesario realizar una petición HTTP GET contra la URL https://api.vivorecuerdo.es/v1/leads/{id} (con un token válido en el header Authorization). Por ejemplo, con cURL:
curl -X GET https://api.vivorecuerdo.es/v1/leads/835 -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJkZXNhcnJvbGxvIiwiaXNzIjoidml2b3JlY3VlcmRvIiwidHlwZSI6IkFVVEhFTlRJQ0FUSU9OIiwiaWF0IjoxNTY1MjY5MDkwLCJleHAiOjE1NjUyNzI2OTB9.mUwuoy6LJF8hI3v9w4hZPaLLqkFLSTani5tlKr8Q2_4OzcCGC-TSc8zNY7oVRT7bGiOdtr5QI7cPbaQdelhG-A'
La otra opción permite obtener los usuarios de los servicios comprendidos entre dos fechas, siendo éste intervalo siempre inferior a seis meses (180 días, concretamente).
En este caso es necesario realizar una petición HTTP GET contra la URL https://api.vivorecuerdo.es/v1/leads?inicio={inicio}&fin={fin} (con un token válido en el header Authorization).
La petición requiere de dos parámetros obligatorios, "inicio" y "fin", ambos fechas con formato yyyy-MM-dd). Por ejemplo, para obtener los usuarios desde el 1 de mayo de 2023 hasta el 1 de octubre de 2023 la URL sería "https://api.vivorecuerdo.es/v1/leads?inicio=2023-05-01&fin=2023-10-01".
Un ejemplo de la petición con cURL:
curl -X GET https://api.vivorecuerdo.es/v1/leads?inicio=2023-05-01&fin=2023-10-01 -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJkZXNhcnJvbGxvIiwiaXNzIjoidml2b3JlY3VlcmRvIiwidHlwZSI6IkFVVEhFTlRJQ0FUSU9OIiwiaWF0IjoxNTY1MjY5MDkwLCJleHAiOjE1NjUyNzI2OTB9.mUwuoy6LJF8hI3v9w4hZPaLLqkFLSTani5tlKr8Q2_4OzcCGC-TSc8zNY7oVRT7bGiOdtr5QI7cPbaQdelhG-A'
Una petición de este tipo devolverá un JSON con el siguiente formato:
[
{
"id_servicio": <id del servicio>,
"tipo_usuario": <Usuario o Administrador>,
"fecha_servicio": <fecha del servicio (DD/MM/AAAA)>,
"nombre_apellidos_servicio": <nombre y apellidos del fallecido>,
"nombre_usuario": <nombre del usuario>,
"parentesco_usuario": <parentesco del usuario>,
"telefono_usuario": <número de teléfono del usuario, con su código de pais>,
"numero_fotos": <número de fotos subidas en ese servicio>,
"numero_mensajes": <número de mensajes de condolencia escritos en ese servicio>,
"digital_book": <true o false, dependiendo de si se ha vendido el Digital Book>,
"notificaciones_comerciales": <true o false, dependiendo de si el usuario autoriza recibir notificaciones comerciales>
},
{
"id_servicio": 56,
"tipo_usuario": "Administrador",
"fecha_servicio": "04/12/2017",
"nombre_apellidos_servicio": "Rafael Baeza López",
"nombre_usuario": "Carlos",
"parentesco_usuario": "Amigo",
"telefono_usuario": "+34XXXXXXXXX",
"numero_fotos": 56,
"numero_mensajes": 49,
"digital_book": true,
"notificaciones_comerciales": false
},
{
"id_servicio": 56,
"tipo_usuario": "Usuario",
"fecha_servicio": "04/12/2017",
"nombre_apellidos_servicio": "Rafael Baeza López",
"nombre_usuario": "Daniel",
"parentesco_usuario": "Amigo",
"telefono_usuario": "+34XXXXXXXXX",
"numero_fotos": 56,
"numero_mensajes": 49,
"digital_book": true,
"notificaciones_comerciales": true
},
...
]
Los campos "id_servicio", "fecha_servicio", "nombre_apellidos_servicio", "numero_fotos", "numero_mensajes" y "digital_book" contienen información relativa al servicio al que pertenece el usuario/administrador, y "tipo_usuario", "nombre_usuario", "parentesco_usuario", "telefono_usuario" y "notificaciones_comerciales" información personal suministrada por el usuario.