Introdução

A API Widget da BonifiQ é uma API pública projetada para integração com frontends de e-commerce, aplicativos móveis e outras interfaces de usuário. Ela permite que consumidores interajam com o programa de fidelidade diretamente na experiência de compra.

Base URL

https://api.bonifiq.com.br/pub/widget

Todos os endpoints documentados nesta referência usam o prefixo /pub/widget/.

Autenticação

A API Widget utiliza dois headers principais para autenticação:

Headers Obrigatórios

string

required

Identificador público da loja (tenant). Este valor é fornecido pela BonifiQ durante a configuração da conta.

string

Token de segurança do usuário, obtido através do endpoint de login seguro (validade de 60 minutos). Obrigatório apenas nos endpoints autenticados.

Fluxo de Autenticação

Estrutura de Resposta Padrão

A maioria dos endpoints retorna uma estrutura padrão BaseWidgetResponse:

{
  "HasError": false,
  "Message": null,
  "Item": {
    // Dados específicos do endpoint
  }
}

Campo	Tipo	Descrição
`HasError`	boolean	Indica se houve erro na requisição
`Message`	string	Mensagem de erro ou sucesso
`Item`	object/array	Dados retornados pelo endpoint

Códigos de Resposta HTTP

Código	Descrição
200	Sucesso
400	Requisição inválida (parâmetros incorretos)
401	Não autorizado (token inválido ou expirado)
404	Recurso não encontrado
500	Erro interno do servidor

Próximos Passos

Autenticação

Configure o login seguro para seus usuários

Cliente

Consulte saldo de pontos e informações do cliente

Recompensas

Liste e resgate recompensas disponíveis

Cashback

Aplique cashback no checkout

Autenticação

Cliente

Recompensas

Gamificação

Outros

Introdução

Base URL

Autenticação

Headers Obrigatórios

Fluxo de Autenticação

Estrutura de Resposta Padrão

Códigos de Resposta HTTP

Próximos Passos

Autenticação

Cliente

Recompensas

Cashback

​Base URL

​Autenticação

​Headers Obrigatórios

​Fluxo de Autenticação

​Estrutura de Resposta Padrão

​Códigos de Resposta HTTP

​Próximos Passos

Autenticação

Cliente

Recompensas

Cashback

Base URL

Autenticação

Headers Obrigatórios

Fluxo de Autenticação

Estrutura de Resposta Padrão

Códigos de Resposta HTTP

Próximos Passos