A API BTG Web permite a integração de eventos de comportamento dos usuários realizados em navegadores web via requisições HTTP, complementando a solução existente baseada em scripts via GTM. Com essa API, os eventos podem ser enviados diretamente para o sistema BTG, garantindo maior flexibilidade e compatibilidade com diferentes plataformas e tecnologias.

URL Base da API

https://c.btg360.com.br/api/web/tracking

Estrutura das Requisições

As requisições para a API BTG Web devem seguir o formato JSON e conter os seguintes parâmetros essenciais:

account (string) - ID da conta fornecido pela equipe Wake Experience.
cookieBid (string) - Identificador único do usuário.
event (string) - Tipo de evento enviado.
Parâmetros específicos dependendo do tipo de evento.

Exemplo de Requisição:

{  
  "account": "100:1",
  "cookieBid": "258755ef-ca9c-4996-9dc7-a2018bbb48da",
  "event": "product",
  "name": "Sapato Masculino",
  "url": "<http://site.com.br/produto/65688">,
  "department": "Masculino",
  "category": "Calçados",
  "subcategory": "Casual",
  "id": "19823718937",
  "brand": "StriderX",
  "price": "128.00"
}

Identificador do Usuário (`cookieBid`)

O cookieBid é um identificador único do usuário e deve ser gerado pela aplicação que faz as chamadas para a API BTG Web. Ele é essencial para rastrear corretamente o comportamento dos usuários e deve seguir as seguintes diretrizes:

Deve ser único para cada usuário mas sua persistência pode variar conforme as regras de negócio da aplicação do cliente. É possível gerar novos cookieBids para o mesmo usuário, se necessário.
Formato recomendado: UUID v4 (exemplo: 258755ef-ca9c-4996-9dc7-a2018bbb48da).
Deve ser armazenado no dispositivo do usuário, podendo ser salvo em um cookie ou localStorage no caso de aplicações web.
O mesmo cookieBid deve ser utilizado em todas as requisições do mesmo usuário, garantindo a integridade dos dados coletados.

Tipos de Eventos Disponíveis

Os eventos suportados pela API BTG Web incluem:

Produto (product) - Registro de visualização de produtos.
Carrinho (cart) - Adição de itens ao carrinho.
Cliente (client) - Identificação do usuário.
Transação (transaction) - Registro de compras.
Busca (search) - Registro de buscas realizadas.
Lista de Desejos (wishlist) - Marcação de produtos como favoritos.
Avise-me (warnme) - Solicitação de notificação para produtos indisponíveis.

Autenticação

A API BTG Web não exige autenticação via tokens. A identificação da conta ocorre pelo campo account, e o rastreamento do usuário se dá pelo cookieBid.

Boas Práticas

Sempre utilize um cookieBid único para identificar corretamente os usuários.
Dados opcionais em todas as páginas (produto, carrinho e pedido finalizado): Departamento, Categoria, Sub-categoria e Marca.
- Observação: “dados opcionais” não são obrigatórios para o funcionamento do BTG, porém a falta deles impossibilita o uso de algumas funcionalidades:
  - Pós Compras (quando configurado para categoria);
  - Novidades;
  - Indecisos;
  - Redução Preços Similares;
  - Tendências;
  - Todos os Módulos de Recomendações: Similares | Mais vendidos | Cross-Sell | Quem viu, comprou | Quem viu, viu também.
Certifique-se de enviar os eventos na ordem correta para não comprometer análises comportamentais.
Valide os dados antes de enviá-los para evitar inconsistências no sistema.

Para detalhes sobre cada evento específico, consulte a documentação individual de cada endpoint.