Navegar na ajuda
- Início da ajuda
- Novidades
- Referência da API
- Status do sistemaEm breve
- Ir para o app
- Falar com suporte
A API do Reton é a porta para outros sistemas conversarem com ele por código: seu PDV, seu e-commerce ou um sistema próprio podem enviar vendas, cadastrar clientes e consultar saldos automaticamente, sem ninguém digitar no painel. É a mesma lógica de negócio da interface — só que acessível por programação.
Autenticação por chave
Toda requisição precisa mandar sua chave de API no cabeçalho X-API-Key. É ela que identifica sua empresa e libera o acesso. Você gera e gerencia essa chave nas configurações — veja em chave de API.
O que dá pra fazer
- Criar contatos — enviar novos clientes do seu site ou sistema direto pra base.
- Registrar vendas — mandar vendas do seu PDV, com deduplicação para não contar a mesma venda duas vezes.
- Estornar vendas — reverter uma venda e a fidelidade que ela gerou.
- Consultar saldo — ler quantos pontos ou quanto de cashback um contato tem.
- Resgatar recompensas — registrar um resgate e listar os resgates já feitos.
- Excluir contatos — mandar um contato para a Lixeira (reversível por 90 dias pelo painel). A exclusão definitiva não é exposta por API de propósito: apagar histórico é decisão de dono, com confirmação na tela.
Como as respostas chegam
Toda resposta vem em JSON com um formato padrão: um campo dizendo se deu certo, os dados (ou o erro, com código e mensagem) e o código da chamada (começa com req_). Com esse código, você acha a chamada no Registro de chamadas, em Configurações › API e Webhooks — e o suporte também. Os detalhes de cada endpoint e campo ficam na Referência da API.
Conecte seus sistemas ao Reton
Gere sua chave de API e comece a enviar vendas e contatos automaticamente do seu PDV ou e-commerce.
Perguntas frequentes
A API consegue cancelar uma venda ou só tirar a pontuação dela?
As duas. O endpoint de estorno aceita `escopo: "venda"` (padrão — cancela a venda e desfaz a recompensa) e `escopo: "recompensa"` (a venda continua valendo e sai só o ponto, cashback ou carimbo). Você aponta a venda pelo código do seu sistema (`codigoItem`/`codigoTransacao`) ou pelo id do Reton (`interacaoId`). A regra é a mesma da tela: se o cliente já usou, a API recusa e diz o motivo.
A API está no meu plano?
A API faz parte do plano Pro em diante. No Free você consegue criar a chave e ler esta documentação, mas as chamadas voltam com um aviso pedindo o upgrade — nada é gravado na sua base.
Estou no Free e minha integração parou. É problema da chave?
Não. Se a chave estivesse errada, o erro seria de autenticação. O que você recebe é um aviso de plano, com o motivo escrito — sua chave continua válida e volta a funcionar assim que a conta virar Pro.
Preciso ser programador para usar?
Sim. A API é feita para quem desenvolve ou integra sistemas. Se você só quer usar o Reton no dia a dia, não precisa dela — o painel já faz tudo.
Como o Reton sabe que a requisição é minha?
Por uma chave de API secreta que você envia no cabeçalho X-API-Key de cada requisição. Cada empresa tem a sua, e ela identifica e autoriza o acesso.
E se o cliente ainda não estiver cadastrado quando a venda chegar?
Por padrão a API responde que não encontrou o cliente e não grava a venda. Se o seu sistema mandar `aguardarCadastro: true`, o Reton **guarda a venda por 30 dias** e ela entra sozinha no momento em que a pessoa se cadastrar (pelo CPF, celular ou código do seu sistema), com a data original da compra e a pontuação dela. Venda com cupom ou com uso de cashback não espera. Detalhes na [Referência da API](/ajuda/api/vendas).
A API cria contatos duplicados?
Não. Assim como no painel, o contato é identificado pelo celular. Se você tentar criar alguém com um celular que já existe, a API avisa em vez de duplicar.
Onde vejo a documentação técnica completa?
Na [Referência da API](/ajuda/api): o passo a passo para começar, cada endpoint com os campos e o comando pronto para copiar, e a coleção do Postman para testar sem terminal. Este artigo é só a visão geral de negócio.
Existe limite de chamadas?
Sim: cada chave faz até 120 chamadas por minuto — sobra para o caixa de uma loja cheia. Passando disso, a API pede para esperar alguns segundos e tentar de novo, sem gravar nada. Se o seu volume for maior, fale com o suporte: o limite pode ser aumentado para uma chave.
Dá para uma chave fazer só uma parte das coisas?
Dá. Cada chave pode ter só as permissões que o sistema usa (por exemplo, o PDV só registra vendas), aceitar chamadas só de certos IPs e ter data de validade. Veja em [chave de API](/ajuda/configuracoes/chave-de-api).
Isso foi útil?
Artigos relacionados
Integrar a maquininha Stone
Conecte sua conta Stone e deixe cada venda na maquininha ser registrada automaticamente no Reton — sem digitar nada.
IntegraçõesIntegrar pelo banco de dados (para sistemas sem API)
Tem um sistema antigo que não tem API, mas tem banco de dados? O Reton conecta direto no banco (via duas views somente-leitura) e importa contatos e vendas sozinho.
IntegraçõesImplantação assistida: a gente configura pra você
Não tem quem cuide da parte técnica? Nossa equipe fala com o seu técnico (ou com o suporte do seu sistema), prepara a integração e acompanha a primeira importação.
Ainda precisa de ajuda?
Não achou o que procurava? A gente responde de gente pra gente.