Pular para o conteúdo
Última atualização

Primeiros Passos

O que é a API Dinie?

A API Dinie permite que parceiros integrem produtos de crédito diretamente em suas plataformas. Através de uma única API REST, você pode cadastrar clientes, apresentar ofertas de crédito, originar empréstimos e acompanhar pagamentos -- tudo sem precisar construir uma infraestrutura de crédito do zero.

A API segue um design orientado a recursos com URLs previsíveis, corpos de request e response em JSON, e métodos e códigos de status HTTP padrão.

Pré-requisitos

Antes de fazer sua primeira chamada à API, você precisa de:

  • Credenciais de sandbox -- um par de client_id e client_secret fornecido pelo seu gerente de conta Dinie
  • Um cliente HTTP (cURL, Postman ou qualquer linguagem de programação com suporte a HTTP)
  • Opcionalmente, um dos SDKs oficiais da Dinie (Node.js, Python ou Ruby)

Info: Entre em contato com seu gerente de conta Dinie para solicitar credenciais de sandbox. As credenciais de sandbox e produção são separadas e não intercambiáveis.

URLs Base

AmbienteURL Base
Produçãohttps://api.dinie.com.br/v3
Sandboxhttps://sandbox.api.dinie.com.br/v3

Todos os exemplos neste guia usam a URL de sandbox. Substitua pela URL de produção quando estiver pronto para ir para produção.

Sua Primeira Chamada à API

O exemplo abaixo inicializa o client com suas credenciais e cadastra uma empresa -- a operação mais comum para começar uma integração. Os SDKs trocam as credenciais por um access token automaticamente.

import Dinie from "dinie";

const dinie = new Dinie({
  clientId: process.env.DINIE_CLIENT_ID,
  clientSecret: process.env.DINIE_CLIENT_SECRET,
  environment: "sandbox",
});

const customer = await dinie.customers.create({
  external_id: "user-42",
  cpf: "123.456.789-00",
  email: "joao@example.com",
  phone: "+5511999999999",
  cnpj: "12.345.678/0001-90",
});

console.log(customer.id);     // "cust_550e8400..."
console.log(customer.status); // "creating"

O cliente é criado com status creating. Quando o enriquecimento de sócios é concluído, o status muda para pending_kyc (via webhook customer.created) e a lista de documentos obrigatórios fica disponível em customer.kyc. O próximo passo é completar o cadastro e aguardar as ofertas de crédito.

Próximos Passos

Agora que você fez sua primeira chamada à API, siga os guias de integração:

  1. Cadastro e Ofertas -- cadastre clientes, complete o KYC e receba ofertas de crédito
  2. Simulação e Contratação -- simule parcelas, formalize empréstimos e acompanhe até o desembolso
  3. Webhooks -- configure endpoints para receber notificações em tempo real
  4. Indo para Produção -- checklist para lançar sua integração