Pular para o conteúdo principal

Checklist

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.

cURL de exemplo
curl --request POST \
  --url https://api.base39.io/v1/products \
  --header 'authorization: Basic <sua-api-key>' \
  --data '
  {
    "slug": "consignado",
    "name": "Empréstimo Consignado",
    "status": "active",
    "settings": {
      "products": {
        "eligibility": {
          "type": "mock",
          "options": {
            "maxLoanAmount": 10000,
            "minLoanAmount": 200,
            "maxNumberOfInstallments": 48,
            "minNumberOfInstallments": 6,
            "maxInstallmentValue": 5000,
            "minInstallmentValue": 200
          }
        },
        "offer": {
          "options": {
            "insurance": {
              "amount": 0,
              "fee": 1.73,
              "type": "required",
              "number": 123456,
              "insurer": "Cia de Seguros"
            },
            "monthlyFee": 1.99,
            "numberOfInstallments": [
              6,
              12,
              18,
              24,
              30,
              36,
              48
            ],
            "daysUntilDisbursement": 7,
            "monthsUntilFirstDueDate": 1,
            "creditOperationType": "CCB",
            "rebates": [
              {
                "feeType": "tac",
                "amountType": "absolute",
                "amount": 250,
                "description": "Tarifa de cadastro"
              }
            ]
          }
        },
        "documents": {
          "toRequest": [
            {
              "purpose": "identity_document_front",
              "name": "Frente do RG/CNH",
              "owner": "customer",
              "expireInDays": 365
            },
            {
              "purpose": "identity_document_back",
              "name": "Verso do RG/CNH",
              "owner": "customer",
              "expireInDays": 365
            },
            {
              "purpose": "pay_stub",
              "name": "Holerite",
              "owner": "customer",
              "expireInDays": 30
            }
          ]
        },
        "disbursement": "mock"
      }
    }
  }
  '

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 --request POST \
  --url https://api.base39.io/v1/funds \
  --header 'authorization: Basic <sua-api-key>' \
  --data '
  {
    "name": "FIDIC 01",
    "document": "000000000000"
  }
  '

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 --request POST \
  --url https://api.base39.io/v1/companies \
  --header 'authorization: Basic <sua-api-key>' \
  --data '
  {
    "name": "Empresa Mock LTDA",
    "document": "000000000000"
  }
  '

Criar operador para o Backoffice​

Crie um operador 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.

info

Consulte as URLs de acesso aos portais com o Suporte da Paketa.

  1. Crie um novo operador
cURL de exemplo
curl --request POST \
  --url https://api.base39.io/v1/operators \
  --header 'authorization: Basic <sua-api-key>' \
  --data '
  {
    "document": "000000000000",
    "name": "John Doe",
    "email": "[email protected]",
    "username": "[email protected]"
  }
  '
  1. Adicione a permissão de backoffice em todas as empresas * no operador usando o id da resposta anterior.
cURL de exemplo
curl --request POST \
  --url 'https://api.base39.io/v1/permissions?operator=<id-do-operador>' \
  --header 'authorization: Basic <sua-api-key>' \
  --data '
  {
    "company": "*",
    "roles": [
      "backoffice"
    ]
  }
  '
  1. Acesse o Backoffice com o email cadastrado.
dica

Você pode usar alias de email para facilitar os testes. Por exemplo, se o seu email é [email protected], use [email protected]. Todos os emails serão enviados para a mesma caixa de entrada do seu email principal.

Criar operador para o Portal da Empresa​

Crie um operador 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.

info

Consulte as URLs de acesso aos portais com o Suporte da Paketa.

  1. Crie um novo operador
cURL de exemplo
curl --request POST \
  --url https://api.base39.io/v1/operators \
  --header 'authorization: Basic <sua-api-key>' \
  --data '
  {
    "document": "000000000000",
    "name": "Jane Doe",
    "email": "[email protected]",
    "username": "[email protected]"
  }
  '
  1. Adicione a permissão de approver e financial na empresa criada no operador usando o id da resposta anterior.
cURL de exemplo
curl --request POST \
  --url 'https://api.base39.io/v1/permissions?operator=<id-do-operador>' \
  --header 'authorization: Basic <sua-api-key>' \
  --data '
  {
    "company": "<id-da-empresa>",
    "roles": [
      "approver",
      "financial"
    ]
  }
  '
  1. 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.

info

Consulte as URLs de acesso aos portais com o Suporte da Paketa.

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)
nota

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.

É necessário o id da empresa criado no item 3 de empresa para preencher o campo company.

cURL de exemplo
curl --request POST \
  --url https://api.base39.io/v1/employments \
  --header 'authorization: Basic <sua-api-key>' \
  --data '
  {
    "status": "working",
    "customer": {
      "document": "000000000000"
    },
    "grossSalary": 10000,
    "netSalary": 8000,
    "hiredAt": "2021-07-25",
    "limitPerInstallment": 2800,
    "company": "<id-da-empresa>"
  }
  '
nota

Não é necessário cadastrar um cliente para criar um novo vínculo empregatício. Nesse momento é usado o documento do cliente.

Configurar etapas da esteira​

Para que a proposta com o desembolso do tipo mock simule o status desembolsado ao final do processo, é necessário configurar apenas o passo de desembolso na esteira.

cURL de exemplo
curl --request POST \
  --url https://api.base39.io/v1/settings \
  --header 'authorization: Basic <sua-api-key>' \
  --data '
  {
    "steps": {
      "desembolso": {
        "title": "Desembolsar",
        "type": "disburse"
      }
    }
  }
  '
nota

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

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.

dica

Os valores da simulação 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.

dica

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.