Checklist para ambiente de teste
Siga esses itens para configurar um ambiente básico e simular as jornadas dos usuários utilizando mock.1
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.cURL de exemplo
cURL de exemplo
2
Criar fundo
Use o endpoint Criar fundo para criar um fundo que será utilizado na CCB e outros procedimentos de cobrança.
cURL de exemplo
cURL de exemplo
3
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.cURL de exemplo
cURL de exemplo
4
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.Consulte as URLs de acesso aos portais com o Suporte da Base39.
- Crie um novo operador
cURL de exemplo
cURL de exemplo
- Adicione a permissão de
backoffice
em todas as empresas*
no operador usando oid
da resposta anterior.
cURL de exemplo
cURL de exemplo
- Acesse o Backoffice com o email cadastrado.
Você pode usar alias de email para facilitar os testes. Por exemplo, se o seu email é john@mail.com, use john+operador@mail.com. Todos os emails serão enviados para a mesma caixa de entrada do seu email principal.
5
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.Consulte as URLs de acesso aos portais com o Suporte da Base39.
- Crie um novo operador
cURL de exemplo
cURL de exemplo
- Adicione a permissão de
approver
efinancial
na empresa criada no operador usando oid
da resposta anterior.
cURL de exemplo
cURL de exemplo
- Acesse o Portal da Empresa com o email cadastrado.
6
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:É necessário o
Consulte as URLs de acesso aos portais com o Suporte da Base39.
- Salário bruto (
grossSalary
) - Salário líquido (
netSalary
) - Data de admissão (
hiredAt
) - Margem consignável (
limitPerInstallment
)
Os dados do objeto
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.id
da empresa criado no item 3 de empresa para preencher o campo company
.cURL de exemplo
cURL de exemplo
Não é necessário cadastrar um cliente para criar um novo vínculo empregatício. Nesse momento é usado o documento do cliente.
7
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.
cURL de exemplo
cURL de exemplo
Você pode configurar várias etapas de verificação antes do desembolso, como averbação, análise de risco, análise de documentos, etc. Veja alguns templates no guia da Esteira
8
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.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.
Os valores da simulação
mock
podem ser alterados alterando a requisição de exemplo no item 1.As configurações da esteira com aprovações manuais ou automáticas podem ser feitas seguindo o guia da Esteira.
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