Chave de API para integrações

Configurações & personalizaçãoAtualizado em 30 de setembro de 20262 min de leitura
Navegar na ajuda
Neste artigo

A chave de API é como uma senha especial que outro sistema usa pra conversar com o Reton em nome da sua empresa. Com ela, um site de cadastro, um PDV ou uma automação consegue criar contatos e registrar ações automaticamente — sem ninguém precisar entrar no painel e digitar.

Como gerar

  1. No menu lateral, abra Configurações.
  2. No grupo Integrações, abra API e Webhooks.
  3. Clique em Nova chave, dê um nome que identifique a integração (ex: "PDV produção") e escolha as permissões — acesso total ou só o que o sistema usa.
  4. Copie a chave na hora e guarde num local seguro — ela só é mostrada por inteiro uma vez.
Gerar a chave funciona em qualquer plano. Usá-la exige o Pro: no Free as chamadas voltam com um aviso de upgrade, sem alterar nada na sua base. Entenda em Usar a API do Reton.
Trate a chave como uma senha. Nunca coloque ela em páginas públicas, prints ou mensagens abertas. Quem tiver a chave pode agir em nome da sua empresa.

Como o sistema integrado usa a chave

Quem faz a integração envia a chave em cada requisição, num cabeçalho chamado `X-API-Key`. O Reton reconhece a chave, identifica a sua empresa e libera a ação. Todo esse detalhe técnico está explicado em usar a API — é a página pra passar pra quem for programar.

Controlar cada chave

No menu ⋯ de cada chave, na lista de chaves:

  • Editar permissões e limites — o que a chave pode fazer (ex.: só registrar vendas), de quais IPs ela aceita chamadas e até quando ela vale.
  • Pausar — a integração para até você clicar em Retomar. A chave não muda; o sistema integrado não precisa ser reconfigurado.
  • Trocar a chave — gera uma chave nova com as mesmas permissões, e a antiga continua funcionando por 24 horas, tempo de atualizar o sistema sem parar de vender.
  • Histórico — quem criou, pausou, trocou ou mudou a chave, e quando.
  • Revogar — o corte é imediato e vale só para aquela chave; ela não volta.

Cada chave pode fazer até 120 chamadas por minuto — sobra para o caixa de uma loja cheia. Se o seu volume for maior, fale com o suporte: o limite pode ser aumentado para uma chave.

Acompanhar o uso

Logo abaixo das chaves ficam o uso dos últimos 14 dias (quantas chamadas por dia, e quantas deram erro) e o Registro de chamadas: cada chamada dos últimos 30 dias, com o resultado e o motivo do erro. Quando o programador disser que uma venda não entrou, peça o código da chamada (começa com req_) e procure por ele ali.

Conecte o Reton aos seus sistemas

Gere sua chave e deixe seus contatos entrarem no Reton automaticamente, direto da sua operação.

Perguntas frequentes

Para que serve a chave de API?

Ela permite que outro sistema (um site, um PDV, uma automação) crie contatos e registre vendas no Reton automaticamente, em nome da sua empresa, sem precisar de login e senha.

É seguro compartilhar a chave?

Não compartilhe com ninguém que não vá integrar. Quem tem a chave faz tudo o que as permissões dela liberam. Se suspeitar de vazamento, use "Trocar a chave" no menu ⋯ e revogue a antiga assim que colocar a nova no sistema.

Perdi a chave. E agora?

Por segurança, a chave só é exibida por inteiro no momento em que é gerada. Se você a perdeu, use "Trocar a chave" no menu ⋯: sai uma chave nova com as mesmas permissões, e a perdida continua funcionando por 24 horas — tempo de atualizar o sistema. Gerar uma chave nova pelo botão "Nova chave" não desliga as outras.

Como pauso uma integração sem apagar a chave?

No menu ⋯ da chave, clique em Pausar. As chamadas com ela passam a ser recusadas até você clicar em Retomar. Diferente de revogar, a chave volta a funcionar — o sistema integrado não precisa ser reconfigurado.

Posso limitar o que cada chave faz?

Sim. Ao criar ou em "Editar permissões e limites", escolha só o que o sistema usa — por exemplo, o PDV só registra vendas. Dá também para liberar a chave só para o IP do servidor da loja e dar uma data de validade a ela.

Como sei se a integração está funcionando?

Na mesma tela, o card de uso mostra quantas chamadas cada chave fez por dia e quantas deram erro, e o Registro de chamadas lista cada uma dos últimos 30 dias, com o motivo de cada erro. Se o programador disser que algo não entrou, peça o código da chamada (começa com req_) e procure lá.

Isso foi útil?

Ainda precisa de ajuda?

Não achou o que procurava? A gente responde de gente pra gente.

Comece a recuperar clientes hoje

Grátis para começar. Veja quem está sumindo já no primeiro dia.

Sem cartão de crédito · Cancele quando quiser