Clientes

Endpoints para cadastro e gerenciamento de clientes na base Falaê.

Cadastrar Cliente

POST /api/clients

Registra um novo cliente na plataforma com geração opcional de link de pesquisa.

Casos de uso:

• Cadastrar clientes para programa de fidelidade
• Gerar link personalizado de pesquisa
• Integrar base de clientes com Falaê

Corpo da Requisição

{
  "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	Obrigatório	Descrição
name	string	Sim	Nome do cliente
email	string	Não*	Email do cliente (*email ou phone é obrigatório)
phone	string	Não*	Telefone do cliente (*email ou phone é obrigatório)
born_date	string	Não	Data de nascimento no formato DD/MM/YYYY
approved	boolean	Sim	Consentimento para receber notificações
search_id	string	Não	ID da pesquisa para gerar link com ID do cliente (UUID)

Exemplo de Requisição

curl -X POST "https://api-b2s.experienciab2s.com/api/clients" \
     -H "Authorization: Bearer SEU_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"
     }'

Resposta de Sucesso (200)

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

Nota: O campo link só é retornado quando search_id é fornecido.

---

Cadastrar Cliente com Consumo

POST /api/clients/consumption

Registra um cliente e vincula informações de consumo no sistema com geração opcional de link de pesquisa.

Casos de uso:

• Registrar compra e solicitar avaliação
• Vincular pedido ao cliente para tracking
• Gerar link de pesquisa pós-compra

Corpo da Requisição

{
  "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	Obrigatório	Descrição
name	string	Sim	Nome do cliente
email	string	Não*	Email do cliente (*email ou phone é obrigatório)
phone	string	Não*	Telefone do cliente (*email ou phone é obrigatório)
born_date	string	Não	Data de nascimento no formato DD/MM/YYYY
approved	boolean	Sim	Consentimento para receber notificações
order_id	string	Sim	Identificador único do pedido no sistema PDV
order_value	number	Sim	Valor do pedido em formato decimal
order_created_at	string	Sim	Timestamp de criação do pedido (ISO 8601 ou 'YYYY-MM-DD HH:mm:ss')
order_type	string	Sim	Tipo do pedido (ex: Delivery, Pickup, Dine-in)
search_id	string	Não	ID da pesquisa para gerar link com ID do cliente e pedido (UUID)

Exemplo de Requisição

curl -X POST "https://api-b2s.experienciab2s.com/api/clients/consumption" \
     -H "Authorization: Bearer SEU_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"
     }'

Resposta de Sucesso (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: O campo link só é retornado quando search_id é fornecido.

---

Cadastrar Clientes em Lote e Disparar Pesquisa

POST /api/clients/dispatch

Registra um grupo de clientes e dispara automaticamente uma pesquisa de satisfação.

Casos de uso:

• Importação de base de clientes
• Disparo de pesquisa para lista de contatos
• Campanha de NPS em lote

Corpo da Requisição

{
  "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	Obrigatório	Descrição
search_id	string	Não	ID da pesquisa
page_id	string	Não	ID da página
dispatch	boolean	Não	Se deve disparar a pesquisa automaticamente
resend_search	number	Não	Número de reenvios da pesquisa
clients	array	Sim	Lista de clientes a serem cadastrados

Campos do Cliente

Campo	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do cliente
email	string	Não*	Email (*email ou phone é obrigatório)
phone	string	Não*	Telefone (*email ou phone é obrigatório)
born_date	string	Não	Data de nascimento (DD/MM/YYYY)
approved	boolean	Sim	Consentimento para notificações

Exemplo de Requisição

curl -X POST "https://api-b2s.experienciab2s.com/api/clients/dispatch" \
     -H "Authorization: Bearer SEU_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
         }
       ]
     }'

Resposta de Sucesso (201)

{
  "message": "Clientes cadastrados e pesquisa enviada com sucesso!"
}

Códigos de Resposta

Código	Descrição
201	Clientes cadastrados com sucesso
400	Erro de validação
403	Token inválido ou usuário não autorizado
404	Token não encontrado