Hierarquia e exceções
As etapas da Esteira podem ser configuradas em três níveis hierárquicos:
- Empresa
- Produto
- Global
Isso significa que é possível configurar etapas da Esteira para uma empresa específica ou um produto. Além disso, também é possível configurar uma etapa para todo o tenant, ou seja, para todas as empresas cadastradas dentro de uma organização.
Exemplo
Veja abaixo exemplos práticos de configurações das etapas da Esteira nos três diferentes níveis:
Global
Imagine um cenário onde seja configurada as etapas de verificação de documentos, análise de crédito, assinatura do RH e desembolso no nível global. Ou seja, no geral, quando um empréstimo é criado, essa será a ordem de execução das etapas da Esteira para toda a organização.
As configurações no nível global podem ser classificadas como padrão e por isso são a última da ordem de prioridade (caso exista mais nenhum outro nível, o global será o considerado).
Produto
Imagine que a organização passe a oferecer um novo produto, por exemplo, antecipação de salário. Para este produto específico, a organização decide que não seriam necessárias as etapas de verificação de documento e análise de crédito. Por se tratar de um produto mais simples, o organização configura a Esteira para que execute apenas as etapas de assinatura do RH e desembolso.
As configurações no nível de produto são específicas de um determinado produto oferecido e são a segunda na ordem de prioridade hierárquica.
Empresa
Assim como no nível de Produto, a configuração no nível de Empresa significa que são específicas de uma empresa. Suponhamos que dentro de um grupo de empresas, tenha uma que queira configurar uma Esteira que atenda suas necessidades específicas. Por exemplo, pode ser que para uma determinada empresa, de acordo com suas demandas, faça sentido ter uma Esteira que não execute a etapa de assinatura do RH.
As configurações no nível de Empresa são a maior da ordem de prioridade, ou seja, são as que serão executadas antes das de Produto e Global respectivamente.
As etapas da esteira são vinculadas no momento da criação do empréstimo. Alterações na configuração não afetam empréstimos já existentes.
Exceção
Da mesma forma como existem os níveis de hierarquia e ordem de prioridade da execução das etapas da Esteira, também existe a funcionalidade de exceção.
A exceção pode ser configurada justamente para ignorar etapas já existentes.
Por exemplo, caso as etapas de verificação de documento, análise de crédito, assinatura do RH e desembolso tenham sido configuradas no nível global, é possível configurar no nível Produto ou Empresa, uma execeção para que, por exemplo, a etapa de assinatura do RH seja ignorada.
A configuração de uma exceção na API se difere da configuração no Console. Veja abaixo como realizar a configuração no Console e na API, respectivamente.
Exemplos
Listamos alguns casos de uso comuns de hieraria e excessões.
Configurando a esteira para não solicitar a averbação de uma empresa específica
- Pelo Backoffice
- Pela API
O primeiro passo é definir todas as etapas padrão na configuração Global.
No Backoffice > Configurações > Esteiras, no campo Nível da esteira, selecione Global
No exemplo que iremos utilizar as seguintes etapas foram cofiguradas no nível Global
- Validação da frente do documento
- Validação do verso do documento
- Averbação da proposta pelo RH
- Desembolso
Para aplicar a exceção no nível de Produto ou Esteira
- No campo Nível de esteira, selecione Produto e depois o produto para o qual deseja criar a exceção (por exemplo, atencipação de salário)
- Selecione Empresa e depois a empresa para qual deseja configurar uma exceção
Suponhamos que você queira ignorar a etapa de averbação da proposta pelo RH, para isso você deve
- Selecionar a etapa
- Clicar em Ignorar etapa
- Salvar e publicar
De acordo com as configurações acima, a etapa de averbação da proposta pelo RH não será executada para o produto e empresa selecionados.
:::noteTambém é possível aplicar o recurso de ignorar etapa dentro de um mesmo nível:::
O primeiro passo é definir todas as etapas padrão na configura ção global.
Atualize a configuração global da esteira utilizando o endpoint Atualizar Configurações da API de Configurações.
curl --request POST \
--url https://api.base39.io/v1/settings \
--header 'authorization: Basic <sua-api-key>' \
--data '
{
"steps": {
"averbacao": {
"title": "Averbação do RH",
"type": "signature",
"methodData": {
"type": "operator",
"role": "approver"
}
}
// ... outras etapas ...
}
}
'
Para criar uma exceção, atualize a configuração da empresa ou do produto, substituindo a etapa de averbação pelo tipo pass. O tipo pass indica que a etapa será automaticamente marcada como concluída, sem necessidade de processamento.
Atualize a configuração da empresa utilizando o endpoint Atualizar empresa.
curl --request POST \
--url https://api.base39.io/v1/companies/<id> \
--header 'authorization: Basic <sua-api-key>' \
--data '
{
"settings": {
"steps": {
"averbacao": {
"type": "pass"
}
}
}
}
'
Respeitando a hierarquia, a configuração final nos empréstimos dessa empresa será uma mescla das etapas presentes tanto na configuração global quanto na configuração específica da empresa. Nesse caso, a esteira resultante terá etapas para averbação do RH, validação de documentos frente e verso.
Note que os parâmetros title e needs foram herdados da configuração global.
{
"steps": {
"averbacao": {
"title": "Averbação do RH",
"type": "pass",
"needs": ["validacaoDocumentoFrente", "validacaoDocumentoVerso"]
},
"validacaoDocumentoFrente": {
"title": "Validação de Documento (Frente)",
"type": "document_verification",
"methodData": {
"purpose": "identity_document_front"
}
},
"validacaoDocumentoVerso": {
"title": "Validação de Documento (Verso)",
"type": "document_verification",
"methodData": {
"purpose": "identity_document_back"
}
}
}
}
Você pode conferir o resultado final criando um empréstimo e consultando as etapas através do endpoint Listar etapas.
curl --request GET \
--url https://api.base39.io/v1/steps?loan=<id> \ # ou /v1/loans/<id>/steps
--header 'authorization: Basic <sua-api-key>'