API Restful con obtención de la información en formato JSON

¿Quieres obtener tus leads de forma rápida y sin restricciones? ¿Para mostrarlos en cualquier interfaz o herramienta? Elija usar la API.

Requisitos previos

Primero, te presentaremos los pasos que te permitirán obtener tus credenciales de ingreso. Estas te permitirán utilizar el endpoint de nuestra API para poder obtener la lista de los leads generados en tus campañas en Appvizer.

Los pasos para el proceso de obtención de credenciales son los siguientes:

  • Para comenzar, proporciónanos una dirección de correo electrónico. Te recomendamos elegir una dirección de correo electrónico genérica o una que no sea susceptible de cambiar, en caso que el o la trabajadora se retiren de la empresa.
  • Luego, nuestro equipo te enviará una invitación por correo electrónico con un enlace de conexión mágico, a partir del cual podrás acceder a la página de modificación de contraseña.
  • Una vez hayas modificado la contraseña, serás redirigido(a) a la página de inicio de sesión. Te recomendamos mantener el enlace a esta página de inicio de sesión en algún lugar a la mano,  ya que también te permitirá solicitar un enlace de cambio de contraseña en caso de que surja un problema.
  • También te recomendamos que anotes la contraseña y la guardes en un lugar seguro, aunque siempre puedas cambiarla. Se utilizará en las consultas de API.

Llamadas a la API

Descriptif de l'endpoint

Request method

POST

url

https://rocket-lead.netlify.app/.netlify/functions/getAll

body (cuerpo)

  • email : String (obligatorio)
  • password : String (obligatorio)
  • filter : (opcional)
    • startDate : Date (format YYYY-MM-DD) (opcional)
    • endDate : Date (format YYYY-MM-DD) (opcional)
  • order: (facultatif)
    • column : Enum("lastname", "email", "date") (obligatorio si order)
    • ascending: Boolean (obligatorio si order)

Ejemplos de cuerpo

En esta parte, el JSON corresponde al cuerpo en formato JSON que enviarás en tu solicitud.

Obtención de la lista con todos tus leads

{
"email": "<votre_mail_d'inscription>",
"password": "<votre_mot_de_passe>"
}

Obtención de la lista con todos tus leads para un periodo determinado

//Recuperación de los leads en la periodi: 01/03/2022 - 30/04/2022
{
"email": "<votre_mail_d'inscription>",
"password": "<votre_mot_de_passe>",
"filter": {
"startDate": "2022-03-01",
"endDate": "2022-04-30"
}
}

//Recuperación de los leads desde el 01/03/2022
{
"email": "<votre_mail_d'inscription>",
"password": "<votre_mot_de_passe>",
"filter": {
"startDate": "2022-03-01"
}
}

//Recuperación de los leads hasta 30/04/2022
{
"email": "<votre_mail_d'inscription>",
"password": "<votre_mot_de_passe>",
"filter": {
"endDate": "2022-04-30"
}
}

Obtención de la lista con todos tus leads ordenados según una columna

Puedes ordenar los clientes potenciales por las columnas de "apellido" o "correo electrónico" de la A a la Z (ascendente: verdadero) y de la Z a la A (ascendente: falso), luego por fecha de creación del más reciente al más antiguo (ascendente: verdadero) y del más antiguo al más nuevo (ascendente: falso).

//Recuperación de los leads en la periodi: 01/03/2022 - 30/04/2022 ordenados por fecha de creación!
{
"email": "<votre_mail_d'inscription>",
"password": "<votre_mot_de_passe>",
"filter": {
"startDate": "2022-03-01",
"endDate": "2022-04-30"
},
"order": {
"column": "date",
"ascending": false
}
}

//Recuperación de los leads ordenados por correo electrónico
{
"email": "<votre_mail_d'inscription>",
"password": "<votre_mot_de_passe>",
"order": {
"column": "email",
"ascending": true
}
}