API's CheckOut (VTEX)

Este documento descreve as APIs necessárias para integrar o sistema de checkout BonifiQ ao aplicativo do cliente. As integrações abrangem login seguro, consulta e aplicação de recompensa. As chamadas são projetadas para garantir uma experiência segura e eficiente para o consumidor.

Principais Etapas

1. Login seguro: Autenticação do usuário e obtenção de token de segurança.
2. Consulta de recompensas: Verificação do saldo e regras para utilização da recompensa.
3. Aplicação de recompensa: Resgate de recompensa no carrinho.
4. Consulta de recompensa aplicado: Verificação do estado da recompensa no carrinho.

O primeiro passo é realizar o login do usuário e obter o seu token de segurança. Esse token de segurança será utilizado em todas as chamadas subsequentes.

Requisição

Corpo da Requisição

Parâmetros

• X-Bq-Tenant: Identificador público da loja.
• sessionToken: Gerado pela plataforma de e-commerce após o login do consumidor.
• segmentToken: Gerado pela plataforma de e-commerce.

Exemplo de Resposta

Descrição dos Campos

• SecureToken: Token de segurança do usuário, com validade de 60 minutos.

Essa etapa será utilizada para a listagem de recompensas disponíveis para o usuário logado:

Requisição

Parâmetros

• purchaseValue: Valor da compra
• X-Bq-Tenant: Identificador da loja.
• X-Bq-SecureToken: Token do usuário obtido no login seguro.
• order_form_id: Identificador do carrinho.

Exemplo de Resposta

• O campo UseReason se refere ao uso da recompensa, podendo possuir os valores abaixo:

• O campo RemainingToUse virá com um valor numérico caso o campo UseReason possua o valor 2 (MinValueNotReached)

Essa etapa será utilizada para a aplicação de recompensas ainda não resgatadas.

Requisição

Corpo da Requisição (Opcional)

Exemplo de Resposta

Esta etapa será utilizada para o caso do cliente saia da tela do checkout e seja necessário reaplicar o estado de recompensa resgatada a ele.

Requisição

Corpo da Requisição (Opcional)

Exemplo de Resposta

Observações Importantes

• As recompensas disponíveis podem variar conforme o valor do carrinho e itens adicionados. Sempre verifique novamente após atualizações no carrinho.
• Certifique-se de tratar as mensagens amigáveis retornadas pela API para melhorar a experiência do usuário.
• O SecureToken tem validade limitada e deve ser atualizado periodicamente.