v1

latestOpenAPI 3.1.02026-08-04650218.3 KB

/api_inicio

API responsável por iniciar o fluxo de geração e resgate dos bônus a partir dos dados do cliente.

post/api_inicio

Headers

Authorizationstring required

Token de autenticação.

CodEmpresastring required

Código da empresa enviado pela CRMBonus

Celularstring required

Celular do cliente em base64.

Content-Typestring required

System-Namestring required

Nome do sistema PDV que está enviando a requisição

User-Agentstring required

Request body

cod_lojainteger required

ID da loja fornecido pelo T.I. do CRM&Bonus.

customer_namestring required

Nome do cliente.

customer_celstring required

Número de celular do cliente com DDD e sem o uso da máscara.

customer_emailstring

Endereço de e-mail do cliente.

customer_birthstring

Data de nascimento do cliente (dia/mês/ano).

customer_cpfstring

Número de CPF do cliente.

category_customstring

Código utilizado para filtrar campanhas específicas quando o endpoint /api_campanha_disponivel for chamado. O valor desse campo precisa ser igual a categoria da campanha desejada.

Response

200

statustrue | false

Se houve sucesso/falha em sua solicitação

messagestring

Mensagem de sucesso/falha da sua solicitação. Confira as mensagens de erro desta rota.

Example response

{
  "status": true,
  "message": "sucesso",
  "data": {
    "loja_id": 12345678,
    "customer_id": 12345678,
    "solicita_pin": true,
    "sms": "NOME DA LOJA: PIN 1168 - Ao passar pin você concorda com https://crm.bo/termo-uso"
  }
}