Desenvolvedores e automação
Uma API REST, webhooks e assinatura eletrônica para os sistemas ao redor da sua carteira de empréstimos
Use a API para ler e gravar tomadores, empréstimos e pagamentos a partir do seu próprio software, os webhooks para saber das mudanças à medida que acontecem e a assinatura eletrônica integrada para obter a assinatura de documentos de empréstimo sem um serviço de assinatura à parte.
curl "https://api.lendbox.io/borrowers?page=1&limit=20" \
-H "Authorization: Bearer live_your_api_key"- Status
- Integrado
- Planos
- API nos planos Business, Growth e Enterprise
- Ambientes
- Sandbox e produção
- Documentação
- api.lendbox.io/docs
Início rápido
Quatro passos do zero até a sua primeira resposta.
- 1Gere uma chaveNo painel, abra API Integration → REST API e selecione Generate New API Key. Guarde-a num lugar seguro. Gerar uma nova chave faz a antiga parar de funcionar, então troque-a sempre que alguém com acesso sair.
- 2Escolha o ambienteSandbox e produção são ambientes separados, cada um com a sua URL base, as suas chaves e os seus dados: https://sandbox-api.lendbox.io e https://api.lendbox.io. As chaves de sandbox começam com sandbox_ e as de produção com live_. Desenvolva primeiro contra o sandbox.
- 3Envie a chave em cada requisiçãoPasse-a como bearer token no cabeçalho Authorization. Os códigos de resposta que a API retorna estão listados na mesma página do painel.
- 4Trabalhe a partir da referênciaCada endpoint, parâmetro e formato de resposta está na documentação pública em api.lendbox.io/docs. A lista de tomadores, por exemplo, é paginada com os parâmetros page e limit.
Uma chave por espaço de trabalho, mostrada com o cabeçalho em que deve ser enviada e as duas URLs base.
O que as equipes constroem com ela
A maioria das integrações se encaixa num destes quatro padrões. Cada um usa endpoints que já estão na referência pública.
Cadastre a partir do seu próprio aplicativo
Crie tomadores e empréstimos a partir do seu próprio site ou aplicativo de cadastro com requisições POST, para que uma solicitação recebida fora do Lendbox nunca precise ser digitada duas vezes.
Lance pagamentos de outro canal
Quando o dinheiro chega a algum lugar a que o Lendbox não se conecta, como uma conta bancária ou uma folha de pagamento, lance o pagamento no empréstimo com uma única chamada a partir do sistema que o recebeu.
Alimente os seus próprios relatórios
Leia tomadores, empréstimos e pagamentos periodicamente para um data warehouse ou uma ferramenta de BI, e use os webhooks para saber quais registros mudaram nesse intervalo.
Dispare os seus próprios fluxos de trabalho
Use o evento de pagamento criado para enviar um agradecimento a partir do seu CRM, ou o evento de empréstimo criado para abrir uma pasta no seu sistema de documentos.
Como funcionam as chaves de API
- Uma chave por espaço de trabalho. Ela age com o acesso do proprietário do espaço de trabalho, então trate-a como a senha do proprietário e mantenha-a no seu servidor, nunca num navegador ou num aplicativo.
- As chaves não expiram sozinhas. Gere a chave novamente no painel para revogá-la.
- Ver e gerenciar a página da API é uma permissão de equipe própria, então você pode limitá-la às pessoas que constroem integrações.
- O acesso à API está incluído nos planos Business, Growth e Enterprise.
Webhooks: saiba das mudanças à medida que acontecem
Adicione um webhook em API Integration → Webhooks: informe a URL de um endpoint que você controla e marque os eventos que ele deve receber. O Lendbox envia um POST em JSON para essa URL cada vez que um deles acontece.
| Registro | Criado | Atualizado | Excluído |
|---|---|---|---|
| Empréstimo | Sim | Sim | Sim |
| Tomador | Sim | Sim | Sim |
| Pagamento | Sim | Sim | Sim |
| Investidor | Sim | Sim | Sim |
| Produto de investimento | Sim | Sim | Sim |
| Conta de investidor | Sim | Sim | Sim |
POST /your/webhook/endpoint
Content-Type: application/json
X-LendBox-Event: <event name>
X-LendBox-Webhook-ID: <your webhook's id>- X-LendBox-Event
- Qual evento foi disparado, para que um único endpoint possa tratar vários.
- X-LendBox-Webhook-ID
- Qual dos seus webhooks enviou a entrega.
Como construir um receptor que aguente
Responda rápido
O Lendbox espera dez segundos pela resposta do seu endpoint. Confirme o recebimento primeiro e faça o trabalho demorado depois.
Trate uma entrega como um sinal
Antes de agir sobre um evento, busque na API o empréstimo, o tomador ou o pagamento que ele indica. Você obtém o registro atual e confirma que o evento é genuíno.
Concilie periodicamente
Cada evento é entregue uma única vez. Uma leitura noturna pela API recupera o que o seu endpoint perdeu enquanto estava fora do ar, e handlers idempotentes tornam uma repetição inofensiva.
Assinatura eletrônica de documentos de empréstimo, integrada
Contratos de empréstimo, extratos e cronogramas de pagamento são assinados dentro do Lendbox, então a cópia assinada fica no empréstimo, e não na conta de outro serviço.
1Monte o modelo
Em Documents → Loan Templates, escreva o contrato no editor com campos variáveis para os dados do tomador e do empréstimo, ou envie um documento do Word que já tenha os campos variáveis.
2Marque onde as pessoas assinam
Nos seus próprios modelos, posicione os campos de assinatura e de texto uma vez, e todo empréstimo que usar esse modelo recebe as mesmas áreas de assinatura. Os documentos integrados Loan Statement e Repayment Schedule já vêm com os blocos de assinatura no lugar.
3Envie os links
Na aba Documents do empréstimo, escolha Send for Signature. Assine como você mesmo, envie ao tomador o link dele por e-mail, adicione o agente de crédito e adicione outros signatários, como um familiar de contato.
4Colete as assinaturas
Cada signatário desenha a assinatura na tela e salva. Cada assinatura gera uma nova versão do PDF, então a contra-assinatura funciona e as versões anteriores ficam no empréstimo.
Os links de assinatura vão para o tomador, o agente de crédito e qualquer outra pessoa que você adicionar.
Cada link de assinatura funciona uma única vez e expira após sete dias.
O que o registro de assinatura guarda
Registrado
- O nome e o papel do signatário: tomador, agente de crédito ou outro
- Quando assinou
- Todas as versões do documento, antes e depois de cada assinatura
Não registrado
- Um código de uso único: nenhum é enviado, então é a posse do link recebido por e-mail que identifica o signatário
- O endereço IP ou o dispositivo do signatário
- Um certificado de conclusão à parte
A equipe pode salvar a própria assinatura em Settings → Admin → My signature e depois preencher com um clique todos os campos atribuídos a cada pessoa.
Perguntas frequentes
- Sim. É uma API REST com documentação pública em api.lendbox.io/docs, ambientes separados de sandbox e de produção e autenticação por bearer token com uma chave que você gera no painel.
- Business, Growth e Enterprise. A assinatura eletrônica está incluída em todos os planos.
- Sim. Inscreva-se no evento de pagamento criado. O Lendbox envia um POST para o seu endpoint quando o pagamento é criado, e você pode então buscá-lo na API para obter o registro completo.
- Isso depende da legislação do lugar onde você concede crédito e do documento, então consulte o seu assessor jurídico. O Lendbox registra quem assinou, em que papel e quando, e guarda todas as versões do PDF assinado no empréstimo.
- Sim. O link de assinatura abre no navegador do celular e o tomador desenha a assinatura com o dedo. Não há nada para instalar.
- Você pode construir essa conexão. A API lê tomadores, empréstimos e pagamentos e os webhooks anunciam as mudanças, então um desenvolvedor pode enviá-los para outro sistema. Não há conector pronto para QuickBooks ou Xero.
O Lendbox tem uma API pública?
Quais planos incluem acesso à API?
Um webhook pode me avisar quando um pagamento é lançado?
As assinaturas eletrônicas do Lendbox têm validade jurídica?
Os tomadores podem assinar pelo celular?
Posso conectar o Lendbox a um software de contabilidade pela API?
Continue lendo
- Todas as integraçõesIntegrações do LendboxDinheiro móvel na Zâmbia, lembretes por SMS e WhatsApp, importação de Excel, a API REST e os webhooks, cada um com a indicação de como se conecta.
- RelacionadosSegurança e controlesPermissões por módulo e por papel, aprovação a quatro olhos e trilha de auditoria.
- RelacionadosVisão geral de segurançaCriptografia, hospedagem, backups e como relatar uma vulnerabilidade.
- RelacionadosCanais de pagamento do tomadorOnde os links de assinatura ficam entre o portal, os links de pagamento e os extratos.
- RelacionadosContabilidade integradaO livro-razão em que cada empréstimo, pagamento e tarifa é lançado.
- RelacionadosMigração de dadosComo trazer tomadores e empréstimos por Excel, em vez de pela API.
Construa sobre o Lendbox
Comece um teste gratuito, leia a referência da API e conecte a produção quando estiver pronto.
Sem cartão