Skip to main content
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

​
X-Bq-Tenant
string
required
Identificador público da loja (tenant). Este valor é fornecido pela BonifiQ durante a configuração da conta.
​
X-Bq-SecureToken
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.
Esta documentação classifica cada endpoint como Público ou Autenticado com base na implementação em Loyalty.Web/Controllers/Widget + Loyalty.Widget.Services.

​
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
  }
}
CampoTipoDescrição
HasErrorbooleanIndica se houve erro na requisição
MessagestringMensagem de erro ou sucesso
Itemobject/arrayDados retornados pelo endpoint

​
Códigos de Resposta HTTP

CódigoDescrição
200Sucesso
400Requisição inválida (parâmetros incorretos)
401Não autorizado (token inválido ou expirado)
404Recurso não encontrado
500Erro 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