Checklist
Este guia fornece uma lista abrangente de itens a serem configurados para inicializar o seu ambiente, seja ele de teste ou de produção, na plataforma.
A plataforma suporta várias camadas de personalização. Este guia se divide em duas partes: configurações básicas iniciais e configurações avançadas, que incluem integrações e regras de negócio.
Checklist para ambiente de teste
Siga esses itens para configurar um ambiente básico e simular as jornadas dos usuários utilizando mock.
Criar produto
Utilize o endpoint Criar produto para criar um novo produto, especificando o nome e slug. Você pode usar name: "Empréstimo Consignado"
e slug: "consignado"
para começar.
Criar fundo
Use o endpoint Criar fundo para criar um fundo que será utilizado na CCB e outros procedimentos de cobrança.
Criar empresa
A empresa é a entidade responsável pela gestão dos convênios, funcionários, política de crédito e produtos, que estão todos vinculados a ela.
Crie uma empresa com name
e document
através do endpoint Criar uma empresa.
Criar operador para o Backoffice
Crie um através do endpoint Criar operador e em seguida configure as permissões através do endpoint Configurar permissões do operador.
Para começar e conhecer melhor como funcionam os fluxos, recomendamos que você crie um operador com a permissão backoffice
com o company: "*"
para permitir o acesso em todas as empresas/convênios.
- Crie um novo operador
- Adicione a permissão de
backoffice
em todas as empresas*
no operador usando oid
da resposta anterior.
- Acesse o Backoffice com o email cadastrado.
Criar operador para o Portal da Empresa
Crie um através do endpoint Criar operador e em seguida configure as permissões através do endpoint Configurar permissões do operador.
Para começar e conhecer melhor como funcionam os fluxos, recomendamos que você crie um operador com as permissões approver
e financial
para a primeira empresa que você criou.
- Crie um novo operador
- Adicione a permissão de
approver
efinancial
na empresa criada no operador usando oid
da resposta anterior.
- Acesse o Portal da Empresa com o email cadastrado.
Criar vínculo empregatício
Você pode fazer a importação de um arquivo com os funcionários através do Portal da Empresa ou através do endpoint Criar vínculo empregatício.
Recomendamos que você informe pelo menos os campos:
- Salário bruto (
grossSalary
) - Salário líquido (
netSalary
) - Data de admissão (
hiredAt
) - Margem consignável (
limitPerInstallment
)
employment.customer
não criam e atualizam os campos do objeto customer
na API de Clientes. As informações de customer
no employment
são apenas para consultar os dados que a empresa fornece e, caso queira, você pode consultar esses dados para fazer relatórios ou campanhas de marketing para incentivar o cadastro. O customer
é criado somente quando o cliente faz o próprio cadastro pelo Portal do Cliente.É necessário o id
da empresa criado no item 3 de empresa para preencher o campo company
.
Configurar etapas da esteira
Para que a proposta com o desembolso do tipo simule o status desembolsado ao final do processo, é necessário configurar apenas o passo de desembolso na esteira.
Enviar proposta
Agora você pode acessar o Portal do Cliente com o documento usado na criação do vínculo empregatício no item 5. Você deve visualizar o produto criado no item 1. Siga os passos para visualizar os valores da simulação e enviar a proposta.
mock
podem ser alterados alterando a requisição de exemplo no item 1.Como configurado no item anterior, todos as propostas criadas serão desembolsadas automaticamente em alguns segundos. O status será alterado para desembolsado e todas as parcelas serão criadas automaticamente. A proposta enviada será exibida no Backoffice e Portal Empresa.
Checklist para ambiente de produção
Siga esses itens para configurar os itens necessários para operar em ambiente produtivo.
- Configurar solicitação de documentos da proposta
- Configurar motivos de reprovação
- Configurar template da CCB
- Configurar passos da esteira
- Configurar elegibilidade do produto
- Configurar cálculo de oferta do produto
- Configurar integração de desembolso
- Configurar integração de boleto
- Configurar um domínio customizado
- Configurar um tema
- Configurar notificações