Conceitos e glossário

Esta página cobre as diferenças e peculiaridades de uma operação de autosserviço de chopp. Se você já opera com chope self-service, vá direto para Escolha sua integração.

Como funciona o autosserviço

O cliente se identifica no totem — a tela instalada junto às torneiras. Ele encosta a credencial, o totem o reconhece e destrava a torneira. Enquanto serve, a tela mostra em tempo real o volume e o valor. Quando ele para, a torneira trava sozinha após alguns segundos.

Durante todo o consumo o seu sistema não é consultado e não precisa fazer nada. A Enjoy.it reconhece a credencial, libera a torneira, mede a dose, calcula o valor e registra a transação. Seu trabalho é antes (dizer quem é o cliente) e depois (trazer o consumo para a conta).

A torneira cobra por mililitro

Numa chopeira comum, o garçom tira um copo de 300 ml e lança "1 chope" na comanda. No autosserviço, o cliente serve a si mesmo e a torneira mede quanto saiu. Se ele tirou 287 ml, paga por 287 ml.

Duas consequências para o seu sistema:

• O valor não é redondo. Uma servida pode custar R$ 12,80 ou R$ 9,47.
• A quantidade não é "1 unidade", é um volume, informado no campo mlServed.

Se o seu PDV só aceita lançar itens com preço fixo de tabela, este é o ponto que exige adaptação.

O preço é definido na Enjoy.it

O produto de cada torneira e o preço por mililitro são cadastrados no sistema da Enjoy.it. Seu PDV não envia preço e não escolhe produto: recebe a transação com product, sellingPrice, mlServed e total já calculados. O campo total é o valor a lançar, sem recálculo.

Quem é o cliente: as quatro credenciais

Uma credencial é o que o cliente apresenta na torneira. Você escolhe uma delas na integração, e ela é o identificador usado em todas as chamadas daquele atendimento.

Código	O que é
idTab	O número impresso na comanda, com três dígitos: 006. A Enjoy.it descobre sozinha qual chip pertence a esse número, e é por isso que o caixa não precisa de leitor
rfid	O código eletrônico do chip dentro do mesmo cartão, com dez dígitos. É a mesma credencial do idTab, vista pelo outro lado
qrCode	Um código criado pela API, para jornadas sem cartão físico. Não existe antes de você pedir
reference	O código do cliente no seu sistema, usado em Wallet. A Enjoy.it deriva a credencial a partir dele, então ele nunca pode mudar

idTab e rfid são o mesmo cartão

Um é o número que a pessoa lê, o outro é o chip que a antena lê. Escolher entre eles é escolher se o seu caixa vai digitar um número ou passar o cartão num leitor.

Quem é a pessoa: uid e consumerReference

Estes dois são trocados com frequência, e apontam para lados opostos:

Código	De quem é	Para que serve
consumerReference	Seu. É o código do cliente no seu PDV	Você envia no check-in para reencontrar o cliente depois, na conciliação
uid	Da Enjoy.it. É o cadastro da pessoa no nosso lado	Vem nas respostas. Junto com createdAt, identifica uma transação

A pessoa é uma só, mas a credencial muda a cada visita: o mesmo uid pode usar a comanda 006 hoje e a 014 amanhã.

Nas transações: idTransaction, sku e idTap

Código	O que é
idTransaction	Identificador único do lançamento. É o que impede cobrar o cliente duas vezes — ver como não duplicar
sku	O código do produto. Configurável na Enjoy.it para carregar o código do seu catálogo, e assim o seu PDV lança no item certo sem casar por nome — que muda a cada troca de barril
idTap	A torneira onde a servida aconteceu

Onde: idPlace

O código do estabelecimento na Enjoy.it, como P-PDV. Vai em toda URL. Sua chave de API vale apenas para os idPlace autorizados pelo cliente na tela de Integrações do sistem Enjoy.

Se o parceiro tem várias lojas, normalmente é uma chave só e o que muda é o idPlace.

Glossário rápido

Termos da operação que aparecem ao longo da documentação:

Termo	O que significa
Servida (ou consumo)	Uma passagem completa na torneira, do destravamento até travar de novo
Tap / torneira	O ponto de saída da bebida, com medidor de volume
Totem	A tela junto às torneiras, onde o cliente se identifica
Kegerator	A geladeira que mantém o barril refrigerado e ligado às torneiras
Comanda	O cartão que o cliente carrega: número impresso por fora, chip por dentro

Termos específicos desta integração:

Termo	O que significa
Check-in	Abrir a sessão: vincular o cliente à credencial e liberá-la para consumo
Checkout	Encerrar a sessão e bloquear a credencial. Não é o pagamento
Sessão	O período entre o check-in e o checkout de uma credencial
Homologação	Ambiente de testes, com chave e loja próprias. Nada aqui cobra de verdade
IPN	Outro nome para webhook nesta API. É a origem de consumptionIpn, balanceIpn e openTapIpn
Modo direct	Habilitação opcional que permite ao seu aplicativo abrir a torneira sem o cliente se identificar no equipamento

Próximo passo

Autenticação e depois a primeira chamada.