A plataforma permite diferentes níveis de configuração. A primeira lista inclui as configurações básicas iniciais. Na segunda lista você aprofundar nas configurações de integrações e regras do seu negócio.

Checklist básico

Siga esses itens para configurar um ambiente básico e simular as jornadas dos usuários utilizando mock.

1. Criar um produto

Crie um produto com nome e slug através do endpoint Criar um produto. Você pode usar name: "Empréstimo Consignado" e slug: "consignado" para começar.

Exemplo de configuração de produto do usando desembolso via mock

curl --request POST \
     --url https://api.base39.io/v1/products \
     --header 'accept: application/json' \
     --header 'authorization: Basic SUA_CHAVE_AQUI' \
     --header 'content-type: application/json' \
     --data '
{
  "status": "active",
  "settings": {
    "products": {
      "eligibility": {
        "options": {
          "maxLoanAmount": 10000,
          "minLoanAmount": 200,
          "maxNumberOfInstallments": 48,
          "minNumberOfInstallments": 6,
          "maxInstallmentValue": 5000,
          "minInstallmentValue": 200
        },
        "type": "mock"
      },
      "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"
    }
  },
  "slug": "consignado",
  "name": "Empréstimo Consignado"
}
'

2. Criar um fundo

O nome e documento do fundo é inserido na CCB e em outras operações de cobrança.

Crie um fundo (FIDIC ou Securitizadora) com name e document através do endpoint Criar uma fundo.

3. Criar uma empresa

Empresa é a entidade que gerencia os seus convênios, os funcionários, política de crédito e produtos são vinculados a essa entidade.

Crie uma empresa com name e document através do endpoint Criar uma empresa.

Exemplo de criação de uma empresa

curl --request POST \
     --url https://api.base39.io/v1/companies \
     --header 'accept: application/json' \
     --header 'authorization: Basic SUA_CHAVE_AQUI' \
     --header 'content-type: application/json' \
     --data '
{
  "document": "63154757000150",
  "name": "Empresa Mock LTDA",
  "status": "active"
}
'

4. Criar um operador

Operadores são os usuários que acessam o Portal da Empresa ou Backoffice. Criar os operadores através do endpoint Criar um operador e posteriormente configure as permissões de RH ou Backoffice através do endpoint Configurar permissões do operador.

Para começar e conhecer melhor como funcionam os fluxos, recomendamos que você crie pelo menos dois usuários e vincule permissões diferentes:

Operador Backoffice: adicione a permissão backoffice com o company: "*" para permitir o acesso em todas as empresas/convênios.
Operador RH: adicione 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.

Exemplo de criação de um operador do Backoffice

curl --request POST \
     --url https://api.base39.io/v1/operators \
     --header 'accept: application/json' \
     --header 'authorization: Basic SUA_CHAVE_AQUI' \
     --header 'content-type: application/json' \
     --data '
{
  "document": "58353852004",
  "name": "Operador Backoffice Mock",
  "email": "SEU_EMAIL+bko@SEU_PROVEDOR.com.br",
  "username": "58353852004"
}
'

É necessário pegar o id do operador gerado na operação anterior para adicionar a permissão:

curl --request POST \
     --url 'https://api.base39.io/v1/permissions?operator=SEU_ID_DE_OPERADOR_BKO_AQUI' \
     --header 'accept: application/json' \
     --header 'authorization: Basic SUA_CHAVE_AQUI' \
     --header 'content-type: application/json' \
     --data '
{
  "company": "*",
  "roles": [
    "backoffice"
  ]
}
'

Exemplo de criação de um operador do Portal RH

curl --request POST \
     --url https://api.base39.io/v1/operators \
     --header 'accept: application/json' \
     --header 'authorization: Basic SUA_CHAVE_AQUI' \
     --header 'content-type: application/json' \
     --data '
{
  "username": "54148474016",
  "document": "54148474016",
  "name": "Operador Portal RH Mock",
  "email": "SEU_EMAIL+rh@SEU_PROVEDOR.com.br"
}
'

É necessário pegar o id do operador e da company criados anteriormente para adicionar a permissão:

curl --request POST \
     --url 'https://api.base39.io/v1/permissions?operator=SEU_ID_DE_OPERADOR_RH_AQUI' \
     --header 'accept: application/json' \
     --header 'authorization: Basic SUA_CHAVE_AQUI' \
     --header 'content-type: application/json' \
     --data '
{
  "company": "COMPANY_CRIADA_ANTERIORMENTE_AQUI",
  "roles": [
    "approver",
    "financial"
  ]
}
'

5. Inserir ou importar 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 esses campos:

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 nem atualizam os campos da entidade customer. 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 seu cadastro.

Exemplo de criação de um vinculo empregatício

É necessário pegar o id retornado no response do passo de criação de empresa para preencher o campo company.

curl --request POST \
     --url https://api.base39.io/v1/employments \
     --header 'accept: application/json' \
     --header 'authorization: Basic SUA_CHAVE_AQUI' \
     --header 'content-type: application/json' \
     --data '
{
  "status": "working",
  "customer": {
    "document": "35010949067"
  },
  "grossSalary": 10000,
  "netSalary": 8000,
  "hiredAt": "2021-07-25",
  "limitPerInstallment": 2800,
  "company": "ID_DA_EMPRESA_CRIADA_ANTERIORMENTE"
}
'

6. Criar o Step de Desembolso Automático

Para que a proposta utilizando o desembolso do tipo mock seja paga ao final do processo, é necessário configurar apenas o passo de desembolso nos steps.

Exemplo de configuração da esteira

curl --request POST \
     --url https://api.base39.io/v1/settings \
     --header 'accept: application/json' \
     --header 'authorization: Basic SUA_CHAVE_AQUI' \
     --header 'content-type: application/json' \
     --data '
{
  "steps": {
    "desembolso": {
      "title": "Emissão do Débito no Bancarizador",
      "type": "disburse"
    }
  }
}
'

7. Enviar uma proposta

Agora você pode acessar o Portal do Cliente com o documento usado na criação do vínculo empregatício no item anterior. Você deve visualizar o produto criado no item 1. Siga os passos para visualizar os valores da simulação e enviar a proposta.

A proposta enviada será exibida no Cockpit e Portal Empresa. As configurações da esteira com aprovações manuais ou automáticas podem ser feitas seguindo o guia Esteira.

Checklist completo

Siga esses itens para configurar os itens necessários para operar em ambiente produtivo.