Pular para o conteúdo
Docs

Começar

Introdução

O que dá para integrar com a Lafra, os modos Teste e Produção e onde pegar as chaves.

Nesta página

O que dá para integrar

A Lafra é o sistema de gestão de empresas de sondagem e geotecnia. Esta documentação é para quem liga o site ou o sistema da empresa à Lafra. Hoje dá para fazer três coisas:

O formulário funciona sem programar nada no servidor: basta colar um trecho de HTML no site. A API e os webhooks são para quem tem um servidor (um CRM, um ERP, uma planilha automatizada).

Teste e Produção

Cada empresa tem dois modos, com chaves separadas: Teste e Produção. Use o Teste enquanto monta a integração; nada do que ele faz aparece para a equipe como se fosse de verdade.

TesteProdução
Chavespk_test_…pk_live_…
sk_test_…sk_live_…
Formulário do siteAbre nos domínios autorizados e também em localhost e 127.0.0.1 (qualquer porta). O pedido só aparece na Atividade recente da Integração.Abre só nos domínios autorizados. O pedido cai em Propostas › Solicitações.
API: criar propostaSó simula: responde o que seria criado, sem gravar.Cria a proposta em elaboração.
API: listar e lerLê as propostas de verdade da empresa.Lê as propostas de verdade da empresa.
WebhookSó o evento de teste (botão “Enviar teste”).Todos os eventos escolhidos.

As chaves

ChavePara quêPode ficar no navegador?
pk_live_…Chave publicável: abre o formulário de orçamento no site.Sim. Ela é pública; quem protege é a lista de domínios.
sk_live_…Chave secreta: autentica os pedidos à API.Nunca. Só no servidor.
whsec_…Segredo do webhook: confere que o envio veio da Lafra.Nunca. Só no servidor.

As chaves têm o prefixo do modo e 30 símbolos aleatórios. A secreta e o segredo do webhook aparecem inteiros uma vez só, ao serem criados: copie e guarde na hora. Depois a tela mostra só o começo e os 4 últimos símbolos.

Onde pegar as chaves

Tudo fica em Propostas › Integração, no app da Lafra. Só o dono e os administradores da empresa abrem essa tela, e a empresa precisa ter um plano ativo. Lá estão:

  • a chave aberta no topo (Teste ou Produção);
  • a chave publicável de cada modo e os domínios autorizados;
  • os campos, os serviços e o tema do formulário, com a prévia e os trechos de instalação;
  • “Chaves de API”: gerar, trocar e revogar a chave secreta;
  • o webhook: endereço, eventos, segredo e “Enviar teste”;
  • a Atividade recente: as últimas chamadas, recusas e envios.
Se você é o desenvolvedor contratado pela empresa, peça ao dono ou a um administrador que gere a chave e mande a você por um canal seguro (nunca num grupo ou num e-mail aberto).

Primeiros passos

  1. Em Integração › Teste, copie o trecho HTML e cole numa página aberta em http://localhost. Mande um pedido e veja a linha na Atividade recente. Formulário de orçamento.
  2. Gere a chave secreta de Teste e liste as propostas com curl. Listar propostas.
  3. Cadastre o endereço do webhook, confira a assinatura no seu servidor e use “Enviar teste”. Conferir a assinatura.
  4. Quando tudo funcionar, autorize os domínios do site e troque as chaves de Teste pelas de Produção.
Central de Ajuda