En este artículo, te mostraremos cómo utilizar la API REST , la cual permite obtener registros específicos según los parámetros proporcionados. A continuación, se detallan los pasos y se presentan ejemplos de uso.

Introducción

La API REST está diseñada para facilitar el acceso a registros almacenados en una base de datos de WordPress. Los parámetros necesarios para realizar una consulta son:

• email: El correo con el que te registraste.
• api_pass: La contraseña API asociada al usuario.
• fecha_inicio: La fecha y hora de inicio para la consulta.
• fecha_fin: La fecha y hora de fin para la consulta (opcional; si no se proporciona, se utilizará la fecha actual a las 11:59 PM).
• telefono_wa: El número de teléfono de WhatsApp del cliente.

Endpoint

El endpoint de la API para obtener registros es:

POST /wp-json/nb-api/v1/registros

Ejemplo de Solicitud

Aquí tienes un ejemplo de solicitud utilizando curl:

curl -X POST https://negociobot.com/wp-json/nb-api/v1/registros \
-H "Content-Type: application/json" \
-d '{
    "email": "tu_correo@dominio.com",
    "api_pass": "contraseña",
    "fecha_inicio": "2024-01-01 00:00:00",
    "fecha_fin": "2024-12-31 23:59:59",
    "telefono_wa": "52123456789"
}'

Ejemplo de Solicitud en Postman

1. Abrir Postman: Inicia Postman en tu computadora.
2. Crear Nueva Solicitud: Haz clic en “New” y selecciona “Request”.
3. Configurar Solicitud:
   • Método: Selecciona POST.
   • URL: Ingresa https://negociobot.com/wp-json/nb-api/v1/registros.
4. Encabezados: Añade un encabezado con Content-Type: application/json.
5. Cuerpo de la Solicitud: Selecciona “raw” y “JSON” como tipo de datos. Luego, ingresa el siguiente JSON:

{
    "email": "tu_correo@dominio.com",
    "api_pass": "contraseña",
    "fecha_inicio": "2024-01-01 00:00:00",
    "fecha_fin": "2024-12-31 23:59:59",
    "telefono_wa": "52123456789"
}

6. Enviar Solicitud: Haz clic en “Send”.

Respuesta Esperada

La respuesta de la API será un JSON que contiene los registros solicitados. Por ejemplo:

[
    {
        "fecha_hora": "2024-03-14 14:01:05",
        "mensaje_recibido": "Hola",
        "mensaje_enviado": "Hola. ¿Cómo te sientes hoy? Estoy aquí para escucharte y ofrecerte apoyo si lo necesitas.",
        "visto": "1",
        "notificado": "1",
        "id_wa": "wamid.HBgNNTIxNzEyMTEyMjBIYIDZGNjRFMUFGRjAxQjY5NzE0N0IxRkE3MDU1ODEzNTIwAA==",
        "id_contexto_wa": null
    },
    // Otros registros...
]

Validación y Manejo de Errores

La API realiza varias validaciones:

• Parámetros Obligatorios: Si alguno de los parámetros obligatorios (email, api_pass, fecha_inicio, telefono_wa) está ausente, la API retornará un mensaje de error indicando cuáles parámetros faltan.
• Formato de Fecha: Si fecha_inicio o fecha_fin no tienen un formato válido (Y-m-d H:i:s), la API retornará un mensaje de error indicando el problema de formato.

Ejemplo de mensaje de error por falta de parámetros:

{
    "mensaje": "Faltan parámetros obligatorios: email, api_pass"
}

Ejemplo de mensaje de error por formato de fecha inválido:

{
    "mensaje": "Formato de fecha_inicio no válido, debe ser Y-m-d H:i:s"
}