Estrutura Inicial Sistema - devbasetecnologia/devmobility GitHub Wiki

Estrutura Inicial para Entendimento e Aplicação do Sistema

Para que a plataforma funcione corretamente, algumas configurações precisam ser realizadas seguindo uma determinada ordem.

Esta Wiki apresenta os principais pontos de configuração do sistema, começando pelos cadastros básicos e avançando até as configurações financeiras.

A ideia é facilitar o entendimento de como as partes da plataforma se relacionam e orientar qual configuração deve ser realizada primeiro.


🧭 Visão geral do fluxo

De forma simplificada, o funcionamento pode ser entendido através do seguinte fluxo:

1️⃣ Filial / Região
        ↓
2️⃣ Prestadores
        ↓
3️⃣ Serviços
        ↓
4️⃣ Serviços por Região
        ↓
5️⃣ Financeiro da Plataforma

Cada etapa possui uma função específica e, em muitos casos, uma configuração depende da etapa anterior.


1️⃣ Filial / Região

📖 O que é?

A Filial e a Região são utilizadas para definir onde a plataforma irá funcionar.

  • Filial: referente a ADMINISTRAÇÃO (franquia etc).
  • Região: referente a PRECIFICAÇÃO.

Em resumo:

📍 Filial = Quem irá Administrar?

📍 Região = Quais cidades a operação irá funcionar?


💡 Por que essa é a primeira etapa?

Antes de configurar serviços e valores, é importante definir onde esses serviços estarão disponíveis. Por padrão durante a etapa de CUSTOMIZAÇÃO já é criado a primeira Filial "Matriz" e a Região da plataforma (com base na Cidade do contrato).

Por exemplo:

Região Jundiaí → Cidade vinculada: Jundiaí e Várzea Paulista (Preços dessa Região afetará ambas as cidades vinculadas)

Região Campinas → Cidade vinculada: Campinas

Dessa forma, posteriormente será possível configurar os serviços de maneira diferente para cada região.

A Região permite organizar a área de atendimento da operação e determinar quais serviços poderão ser disponibilizados naquele local, podendo vincular CIDADES que estarão dentro dessa configuração de valores.

Os valores são definidos posteriormente no SERVIÇO POR REGIÃO.

⚠️ Atenção: Antes de avançar para as próximas etapas, confira se:

  • A Filial está cadastrada corretamente?
  • As Regiões necessárias foram cadastradas?
  • As cidades estão vinculadas à Região correta?
  • Crie Regiões Novas apenas para separar Preços, se for valores iguais, utilize a mesma Região.

2️⃣ Cadastros de Prestadores

📖 O que é?

Os Prestadores são as pessoas responsáveis por realizar as corridas ou prestar os serviços disponibilizados pela plataforma.

Nesta etapa são realizados os cadastros e as configurações necessárias para que o prestador possa utilizar o sistema.

Em resumo:

👤 Prestador = Quem irá realizar o atendimento


✅ Aprovação do Prestador

O cadastro de um prestador não significa necessariamente que ele já esteja apto a realizar corridas.

Dependendo das regras da operação, o prestador deverá passar pelo processo de aprovação antes de começar a operar.

Fluxo:

Prestador cadastrado
        ↓
Análise / Conferência
        ↓
Prestador aprovado
        ↓
Pode operar na plataforma

⚠️ Atenção: Antes de verificar problemas relacionados ao recebimento de corridas, confirme se o prestador está:

  • Cadastrado.
  • Aprovado.
  • Ativo.
  • Próximo ao Cliente.
  • Flag de Ativo/Habilitado Prestador marcados para o Serviço.
  • Flag de Ativo/Habilitado Prestador marcados para o Tipo de Pagamento.

💰 Tipo de Acerto Prestador

O Tipo de Acerto define como será realizado o tratamento financeiro entre o prestador e a plataforma.

Os 3 tipos de acerto são:

Tipo de Acerto Funcionalidade
Pré-Pago Credito Define um limite negativo que o prestador poderá ter no saldo.
Pré-Pago Período Prestador pode comprar uma "Mensalidade" para poder operar na plataforma (dias definidos pelo próprio administrador na configuração da periodicidade)
Pós-Pago Define uma data que os prestadores terão para realizar o acerto antes de ficar Inadimplentes.

3️⃣ Serviços

📖 O que é?

Os Serviços representam as categorias ou modalidades que estarão disponíveis na plataforma.

É nesta etapa que definimos o que será oferecido ao passageiro.

🚗 Exemplo Uma operação pode possuir serviços como:

  • 🚗 Carro Econômico.
  • 🚘 Carro Executivo.
  • 🏍️ Moto.
  • 🚐 Van.
  • 🚕 Táxi.

Observação: Os serviços disponíveis dependem da configuração e das necessidades de cada operação.


🎯 O que é configurado nesta etapa?

Dependendo da operação, podemos configurar:

  • Nome do serviço.
  • Tipo de veículo.
  • Características da categoria. (Mobilidade / Entrega)
  • Status do serviço.
  • Regras específicas. (Serviço Conveniado / Feminino / Guincho etc)

💡 Exemplo

1 - Serviço: Econômico

Tipo de veículo: Carro

2 - Serviço: Moto

Tipo de veículo: Moto

Cada serviço representa uma categoria diferente que poderá ser disponibilizada na plataforma com base nos prestadores e os veículos que cadastrem.

⚠️ Atenção: Criar um serviço não significa necessariamente que ele já estará disponível para todos os usuários. Ainda será necessário realizar as configurações ao Serviço por Região e liberação no Prestador.


4️⃣ Serviços por Região

📖 O que é?

Depois de criar os Serviços e definir as Regiões, é necessário determinar os VALORES dos serviços em cada região.

É nesta etapa que são configuradas grande parte das regras de funcionamento e precificação.


💰 O que pode ser configurado?

Entre as principais configurações estão:

  • Tarifa mínima.
  • Preço base.
  • Preço por KM.
  • Preço por minuto.
  • Paradas adicionais.
  • Taxas.
  • Repasse dos motorista.
  • Recalculo.
  • Retirada/Retorno.
  • Faixas de Preço.

🧮 Exemplo

Imagine que exista o serviço:

🚗 Econômico

E duas regiões:

📍 Região A

📍 Região B

Podemos configurar valores diferentes para cada uma delas:

Serviço Região Tarifa Minima Preço Base Valor por KM
Econômico Região A R$10,00 R$5,00 R$2,00
Econômico Região B R$11,99 R$6,50 R$3,00

Dessa forma, o mesmo serviço pode funcionar com valores e regras diferentes dependendo da região.


🔗 Como as configurações se relacionam?

Podemos entender da seguinte maneira:

**📍 Região**: Define **ONDE** a operação funciona.
        ↓
**🚗 Serviço**: Define **O QUE** será oferecido.
        ↓
**⚙️ Serviço por Região**: Define **COMO** aquele serviço irá funcionar naquela região.

5️⃣ Financeiro da Plataforma

Todos o fluxo de movimentações da plataforma irá depender de algumas configurações realizadas no Prestador e seu Tipo de Acerto, assim como o Serviço por Região e também os Tipos de Pagamento utilizados nas solicitações.

Dependendo do Tipo de Acerto do Prestador e o Saldo do motorista na Plataforma o motorista precisará PAGAR um valor para a plataforma ou RECEBER um valor da plataforma

  • Saldo Positivo = Receber da plataforma.
  • Saldo Negativo = Pagar a plataforma.

💵 Tipos de Pagamento:

Todas as solicitações criadas pelos clientes poderão ser utilizados Tipos de Pagamento de duas configurações:

  • "Em posse do Prestador"
  • "Em posse da Plataforma"
Posse do Pagamento Funcionalidade
Em posse do Prestador É o tipo de pagamento que o prestador irá receber do cliente no próprio veiculo, como por exemplo o DINHEIRO / Maquina de Cartão, assim ele receberá o valor da corrida, e dentro da PLATAFORMA o saldo dele será descontado um valor de acordo com o REPASSE que configurou.
Em posse da Plataforma É o tipo de pagamento que o cliente paga direto pelo aplicativo e entra no saldo do prestador na PLATAFORMA, como por exemplo "Saldo", "Cartão de Credito" e "Faturado", assim entrando o valor positivo da solicitação DIRETO no saldo dele na plataforma já descontando o repasse.

🔗 O que é Gateway de Pagamento?

Dentro do sistema possuem GATEWAYS DE PAGAMENTO integrado:

  • Pagar.me
  • Cielo
  • Mercado Pago
  • GetNet

Ao configurar esses Gateways de Pagamento no sistema o cliente e motorista poderão ter acesso aos recursos de Cartão de Credito e Pix para pagamento de Corridas (Cliente) ou Recargas/Acertos (Cliente/Motorista).

Todas as movimentações realizadas na plataforma com Cartão de Credito ou Pix irão entrar na sua conta do Gateway de Pagamento para poder sacar futuramente.


💰 Como o motorista pode pagar/receber o saldo?

SALDO NEGATIVO

  • Sistema CONFIGURADO com GATEWAY: Motorista poderá PAGAR o valor DEVEDOR (negativo) com Cartão de Credito/Pix direto no aplicativo.
  • Sistema SEM GATEWAY: Motorista precisará pagar por FORA da plataforma e o administrador realizar uma RECARGA MANUALMENTE.

SALDO POSITIVO

  • Independente de possuir gateway ou não, não é possível realizar transferências diretamente pelo sistema
  • O administrador precisa realizar a transferência por fora da plataforma.

⚠️ Atenção

As configurações apresentadas nesta Wiki possuem relação entre si.

Uma configuração incorreta em uma etapa inicial pode afetar o funcionamento das etapas seguintes.

Por isso, recomendamos seguir a ordem:

Filial / Região → Prestadores → Serviços → Serviços por Região → Financeiro


💼 Boas práticas

✔ Realize primeiro as configurações estruturais da operação.

✔ Cadastre as Regiões antes de configurar os Serviços por Região.

✔ Cadastre e aprove os Prestadores antes de realizar os testes de distribuição.

✔ Configure os Serviços antes de configurar suas regras por Região.

✔ Após realizar as configurações, faça testes utilizando o fluxo completo.

✔ Evite realizar várias alterações ao mesmo tempo quando estiver investigando um problema.

✔ Mantenha um registro das configurações importantes realizadas na plataforma.


📚 Próximas páginas

Cada uma das etapas apresentadas nesta Wiki possuem uma documentação própria e mais detalhada.

📍 1. Filial / Região

LINK AQUI.

👤 2. Cadastros de Prestadores

LINK AQUI.

🚗 3. Serviços

LINK AQUI.

⚙️ 4. Serviços por Região

LINK AQUI.

💰 5. Financeiro da Plataforma

LINK AQUI.


⚠️ **GitHub.com Fallback** ⚠️