Clientes

Endpoints para registro y gestión de clientes en la base Falaê.

Registrar Cliente

POST /api/clients

Registra un nuevo cliente en la plataforma con generación opcional de enlace de encuesta.

Casos de uso:

• Registrar clientes para programa de fidelidad
• Generar enlace personalizado de encuesta
• Integrar base de clientes con Falaê

Cuerpo de la Solicitud

{
  "name": "John Doe",
  "email": "johndoe@example.com",
  "phone": "(00) 0 0000-0000",
  "born_date": "25/02/1980",
  "approved": true,
  "search_id": "102a525c-0ce3-4182-a504-aad595425233"
}

Campo	Tipo	Obligatorio	Descripción
name	string	Sí	Nombre del cliente
email	string	No*	Email del cliente (*email o phone es obligatorio)
phone	string	No*	Teléfono del cliente (*email o phone es obligatorio)
born_date	string	No	Fecha de nacimiento en formato DD/MM/YYYY
approved	boolean	Sí	Consentimiento para recibir notificaciones
search_id	string	No	ID de la encuesta para generar enlace con ID del cliente (UUID)

Ejemplo de Solicitud

curl -X POST "https://api-b2s.experienciab2s.com/api/clients" \
     -H "Authorization: Bearer SU_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "name": "John Doe",
       "email": "johndoe@example.com",
       "phone": "(00) 0 0000-0000",
       "born_date": "25/02/1980",
       "approved": true,
       "search_id": "102a525c-0ce3-4182-a504-aad595425233"
     }'

Respuesta Exitosa (200)

{
  "message": "Client created with success",
  "id": "ef9fa264-3850-4bd2-875e-2b40a4dd432f",
  "link": "https://pesquisa.falae.app"
}

Nota: El campo link solo se retorna cuando se proporciona search_id.

---

Registrar Cliente con Consumo

POST /api/clients/consumption

Registra un cliente y vincula información de consumo en el sistema con generación opcional de enlace de encuesta.

Casos de uso:

• Registrar compra y solicitar evaluación
• Vincular pedido al cliente para seguimiento
• Generar enlace de encuesta post-compra

Cuerpo de la Solicitud

{
  "name": "John Doe",
  "email": "johndoe@example.com",
  "phone": "(00) 0 0000-0000",
  "born_date": "25/02/1980",
  "approved": true,
  "order_id": "plataforma-22",
  "order_value": 25.5,
  "order_created_at": "2025-01-14T10:00:00Z",
  "order_type": "Delivery",
  "search_id": "102a525c-0ce3-4182-a504-aad595425233"
}

Campo	Tipo	Obligatorio	Descripción
name	string	Sí	Nombre del cliente
email	string	No*	Email del cliente (*email o phone es obligatorio)
phone	string	No*	Teléfono del cliente (*email o phone es obligatorio)
born_date	string	No	Fecha de nacimiento en formato DD/MM/YYYY
approved	boolean	Sí	Consentimiento para recibir notificaciones
order_id	string	Sí	Identificador único del pedido en el sistema PDV
order_value	number	Sí	Valor del pedido en formato decimal
order_created_at	string	Sí	Timestamp de creación del pedido (ISO 8601 o 'YYYY-MM-DD HH:mm:ss')
order_type	string	Sí	Tipo del pedido (ej: Delivery, Pickup, Dine-in)
search_id	string	No	ID de la encuesta para generar enlace con ID del cliente y pedido (UUID)

Ejemplo de Solicitud

curl -X POST "https://api-b2s.experienciab2s.com/api/clients/consumption" \
     -H "Authorization: Bearer SU_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "name": "John Doe",
       "email": "johndoe@example.com",
       "phone": "(00) 0 0000-0000",
       "born_date": "25/02/1980",
       "approved": true,
       "order_id": "plataforma-22",
       "order_value": 25.5,
       "order_created_at": "2025-01-14T10:00:00Z",
       "order_type": "Delivery",
       "search_id": "102a525c-0ce3-4182-a504-aad595425233"
     }'

Respuesta Exitosa (200)

{
  "message": "Client and consumption successfully registered!",
  "client": {
    "id": "ef9fa264-3850-4bd2-875e-2b40a4dd432f"
  },
  "consumption": {
    "id": "18d12320-ebbf-4688-a4fa-67481aceb929"
  },
  "link": "https://pesquisa.falae.app"
}

Nota: El campo link solo se retorna cuando se proporciona search_id.

---

Registrar Clientes en Lote y Disparar Encuesta

POST /api/clients/dispatch

Registra un grupo de clientes y dispara automáticamente una encuesta de satisfacción.

Casos de uso:

• Importación de base de clientes
• Disparo de encuesta para lista de contactos
• Campaña de NPS en lote

Cuerpo de la Solicitud

{
  "search_id": "search_id",
  "page_id": "page_id",
  "dispatch": true,
  "resend_search": 1,
  "clients": [
    {
      "name": "John Doe",
      "email": "johndoe@example.com",
      "phone": "(00) 0 0000-0000",
      "born_date": "25/02/1980",
      "approved": true
    },
    {
      "name": "Jane Doe",
      "email": "janedoe@example.com",
      "phone": "(00) 0 0000-0000",
      "born_date": "15/10/1985",
      "approved": true
    }
  ]
}

Campo	Tipo	Obligatorio	Descripción
search_id	string	No	ID de la encuesta
page_id	string	No	ID de la página
dispatch	boolean	No	Si debe disparar la encuesta automáticamente
resend_search	number	No	Número de reenvíos de la encuesta
clients	array	Sí	Lista de clientes a registrar

Campos del Cliente

Campo	Tipo	Obligatorio	Descripción
name	string	Sí	Nombre del cliente
email	string	No*	Email (*email o phone es obligatorio)
phone	string	No*	Teléfono (*email o phone es obligatorio)
born_date	string	No	Fecha de nacimiento (DD/MM/YYYY)
approved	boolean	Sí	Consentimiento para notificaciones

Ejemplo de Solicitud

curl -X POST "https://api-b2s.experienciab2s.com/api/clients/dispatch" \
     -H "Authorization: Bearer SU_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "search_id": "search_id",
       "page_id": "page_id",
       "dispatch": true,
       "resend_search": 1,
       "clients": [
         {
           "name": "John Doe",
           "email": "johndoe@example.com",
           "phone": "(00) 0 0000-0000",
           "born_date": "25/02/1980",
           "approved": true
         }
       ]
     }'

Respuesta Exitosa (201)

{
  "message": "Clientes registrados y encuesta enviada exitosamente!"
}

Códigos de Respuesta

Código	Descripción
201	Clientes registrados exitosamente
400	Error de validación
403	Token inválido o usuario no autorizado
404	Token no encontrado