Autenticação
O que é a chave de API
A chave de API é a senha do seu sistema. Toda chamada que o seu sistema fizer precisa levar essa chave junto. É assim que sabemos que quem está abrindo uma comanda é o PDV do parceiro, e não outra pessoa qualquer.
Você recebe duas chaves diferentes, uma para cada ambiente:
| Ambiente | Para que serve | URL base |
|---|---|---|
| Homologação | Testar à vontade | https://api-demo.letsenjoy.it/pos |
| Produção | A operação real da loja | https://api.letsenjoy.it/pos |
As chaves são diferentes em cada ambiente e não são intercambiáveis. Uma chave de homologação usada em produção é simplesmente recusada — e o contrário faria você mexer em comandas reais durante um teste.
Como enviar a chave
Envie a chave no header x-api-key, em todas as chamadas:
x-api-key: SUA_CHAVE_DE_API
Content-Type: application/json
Content-Type é necessário sempre que a chamada tiver corpo, ou seja, em POST e PUT.
Teste se está funcionando
Faça esta chamada trocando P-SUALOJA pelo idPlace que você recebeu. Ela apenas lista as
comandas abertas e não altera nada, então é segura para repetir quantas vezes quiser:
curl --request GET \
--url 'https://api-demo.letsenjoy.it/pos/places/P-SUALOJA/tabs' \
--header 'x-api-key: SUA_CHAVE_DE_API'
O que a resposta significa:
| Você recebeu | Significa |
|---|---|
200 com uma lista (mesmo vazia: []) | Está tudo certo. Pode seguir para os primeiros passos |
403 | A chave é válida, mas não tem permissão para essa loja. Confira o idPlace |
| Requisição recusada, sem resposta da API | A chave está ausente, errada ou com espaço/quebra de linha sobrando |
429 | Você chamou muitas vezes seguidas. Espere alguns segundos |
Uma lista vazia é resultado normal e esperado: significa que a autenticação passou e que nenhuma comanda está aberta na loja neste momento.
O escopo da sua chave
Cada chave pertence a um parceiro e vale apenas para os estabelecimentos vinculados a ele. O
idPlace que você usa na URL precisa estar dentro desse escopo.
Se o seu parceiro tem várias lojas, normalmente uma única chave atende todas elas — o que muda é
o idPlace na URL. Confirme a lista de lojas autorizadas na homologação.
Onde guardar a chave
As chamadas para a Enjoy.it são de servidor para servidor. Isso significa que quem chama a API é o seu backend, nunca a tela do cliente.
Qualquer pessoa consegue ler o código que roda no navegador ou dentro de um aplicativo de celular. Uma chave colocada ali pode ser copiada e usada por terceiros para abrir comandas, registrar recargas e liberar chope na sua loja.
Checklist do que fazer:
- Guarde a chave em variável de ambiente, arquivo de configuração protegido ou cofre de segredos.
- Use HTTPS em todas as chamadas — as suas e as dos seus webhooks.
- Não grave a chave em log, mensagem de erro, print de tela ou ferramenta de analytics.
- Não versione a chave no Git.
- Se desconfiar que vazou, peça a rotação imediatamente.
Como obter acesso
Solicite as credenciais de homologação pelo e-mail tech@letsenjoy.it, informando:
- Nome do parceiro e do sistema de PDV.
- Estabelecimentos que serão integrados.
- Tipo de operação: pré-paga ou pós-paga.
- CNPJ da empresa.
- Razão social.
- Endereço completo.
- Nome do representante legal.
- E-mail do representante legal.
- CPF do representante legal.
Caso algum dado ainda não esteja disponível, informe-o como pendente.
Você receberá um NDA e após assinar será enviada a chave de homologação, o idPlace de teste e o contato técnico para agendar uma reunião inicial e outra de homologação.
Você terá suporte por WhatsApp para ajudar no processo de integração e possíveis dúvidas
Próximo passo
Com a chave em mãos, faça sua primeira chamada.