**Atualizado em:** 2026-05-25
**Gerar HTML:** `php scripts/generate-manual.php`
---
---
Acesse /cadastrar-se e preencha:
| Campo | Descrição |
| Razão social | Nome jurídico da empresa |
| Nome fantasia | Como aparece no sistema |
| Nome da empresa principal | Opcional — usa o nome do locatário se vazio |
| CNPJ / CPF | Documento |
| E-mail do locatário | E-mail de contato do tenant |
| Telefone | Telefone |
| Ramo de atividade | Agrícola, ERP, Barbearia, Oficina, Eletrônica, E-commerce |
| Plano | Gratuito, Básico, Premium, Enterprise |
| Slug do locatário | Identificador na URL (ex: `minha-empresa`) |
| Nome do administrador | Nome do usuário master |
| E-mail do administrador | Login será igual ao e-mail |
| Senha inicial | Senha do primeiro acesso |
Ao cadastrar, o sistema cria automaticamente:
---
Acesse /login. Informe:
Links auxiliares:
Acesse /{slug}/login. O slug já está preenchido. Informe login e senha.
---
Após o login, você vê as empresas cadastradas no tenant. Cada empresa mostra seu modelo de negócio e filiais vinculadas.
Clique em Abrir empresa para entrar no layout correspondente:
Se houver apenas uma empresa, o redirecionamento é automático.
---
Acesse /{slug}/admin.
| Botão | Destino |
| Painel geral | Admin com todos os recursos do seu ramo |
| Agricultura | Apenas recursos agrícolas |
| Empresas / Filiais | Tela dedicada de estrutura |
| Portal | Voltar ao portal do tenant |
| Sair | Logout |
| Novo registro | Criar novo item do recurso selecionado |
Menu agrupado por categorias. Clique no grupo para expandir e nos itens para navegar.
1. Selecione um recurso na sidebar
2. A tabela lista os registros com os campos principais
3. Use a busca para filtrar
4. Novo registro: botão verde no topo → preenche formulário → salvar
5. Editar: clique no botão cinza na linha
6. Excluir: clique no botão vermelho → confirme
7. Imprimir: botão azul ao lado da busca → escolha formato (Tela, HTML, Excel, TXT)
Campos que referenciam outras tabelas (ex: farm_id, soil_type_id) mostram uma lupa. Clique para pesquisar e selecionar o registro vinculado.
---
Acesse /{slug}/admin/empresas-filiais ou pelo botão na barra superior.
Ao criar uma empresa, uma filial principal é gerada automaticamente.
---
Acesse /{slug}/admin/agricultura.
| Grupo | Recursos |
| 🌾 Produção | Fazendas, Talhões, Tipos de solo, Culturas, Safras |
| 📡 Monitoramento | Sensores, Tipos de sensores, Unidades de medida, Localizações, Leituras, Regras, Alertas |
| 🧪 Insumos | Insumos agrícolas, Adubações, Defensivos, Receitas agronômicas, Análises de solo |
| 🔍 Rastreabilidade | Lotes de produção, Rastreabilidade |
| 📦 Estoque | Movimentações, Locais de armazenamento |
| 💰 Comercial | Pedidos de venda, Cotações, Custos |
| ✅ Qualidade | Certificações, Planos de ação |
| 🔧 Serviços | Assistência técnica, Cursos, Processamentos, Eventos |
| 👤 Pessoas | Operadores |
| 📝 Utilitários | Observações |
1. Localizações → cadastre os locais
2. Tipos de solo → cadastre os tipos
3. Tipos de sensores → vincule à unidade de medida
4. Fazendas → cadastre com localização
5. Talhões → subdivida com tipo de solo
6. Culturas → cadastre as culturas
7. Safras → crie o ciclo (talhão + cultura)
8. Unidades de medida → verifique as unidades padrão
9. Sensores → vincule ao talhão, tipo e localização
10. Insumos agrícolas → fertilizantes, defensivos, sementes
11. Leituras → registre dados dos sensores (via API ou painel)
12. Alertas → monitore condições críticas
Ao cadastrar uma leitura (POST /api/v1/leituras), o sistema:
1. Persiste a leitura
2. Busca regras ativas para o tipo do sensor
3. Avalia a condição (ex: temperatura > 35)
4. Se atendida, gera um alerta automaticamente
Regras padrão já criadas no seed:
---
/{slug}/api/v1
POST /api/v1/auth/login
{"tenant_slug": "...", "login": "...", "password": "..."}
Resposta: token Bearer + dados do tenant/usuário + permissões.
Authorization: Bearer SEU_TOKEN
Content-Type: application/json
| Método | URL | Descrição |
| GET | `/{slug}/api/v1/{recurso}` | Listar (query: `?limit=50&offset=0`) |
| POST | `/{slug}/api/v1/{recurso}` | Criar |
| GET | `/{slug}/api/v1/{recurso}/{id}` | Detalhar |
| PUT | `/{slug}/api/v1/{recurso}/{id}` | Atualizar |
| DELETE | `/{slug}/api/v1/{recurso}/{id}` | Excluir |
# Listar fazendas
GET /minha-empresa/api/v1/fazendas
# Criar talhão
POST /minha-empresa/api/v1/talhoes
{"farm_id": 1, "name": "Talhão Norte", "area": 25.5, "soil_type_id": 1}
# Registrar leitura de sensor
POST /minha-empresa/api/v1/leituras
{"sensor_id": 1, "value": 25.5, "unit_id": 3, "reading_at": "2026-05-24 14:30:00"}
---
Cada recurso tem 4 ações: view, create, update, delete.
O sistema de permissões usa três níveis:
| Nível | Descrição |
| `is_super_admin` | Acesso total a qualquer tenant + recursos administrativos |
| `is_tenant_owner` | Acesso total ao próprio tenant (exceto recursos admin) |
| Grupo/Usuário | Permissões granulares via `user_permissions` e `group_permissions` |
Para configurar permissões (super admin):
1. permissions — ver permissões disponíveis
2. user-permissions — conceder a um usuário
3. group-permissions — conceder a um grupo
---
Usuários com is_super_admin = 1:
Para promover um usuário:
UPDATE users SET is_super_admin = 1 WHERE id = SEU_ID;
---
1. Na tela de login, clique em Esqueci minha senha
2. Digite o e-mail cadastrado
3. Um link de redefinição será enviado por e-mail (válido por 1 hora)
4. Acesse o link e defina uma nova senha
---
| Grupo | Submenus |
| 🏢 Estrutura | Empresas e filiais |
| 👥 Usuários & Acesso | Usuários, Grupos, Permissões (apenas super admin) |
| ⚙️ Configurações | Parâmetros, Layouts (apenas super admin) |
| 🌾 Produção | Fazendas, Talhões, Tipos de solo, Culturas, Safras |
| 📡 Monitoramento | Sensores, Tipos, Unidades, Localizações, Leituras, Regras, Alertas |
| 🧪 Insumos | Insumos, Adubações, Defensivos, Receitas, Análises de solo |
| 🔍 Rastreabilidade | Lotes, Rastreabilidade |
| 📦 Estoque | Movimentações, Armazenamento |
| 💰 Comercial | Pedidos, Cotações, Custos |
| ✅ Qualidade | Certificações, Planos de ação |
| 🔧 Serviços | Assistência, Cursos, Processamentos, Eventos |
| 👤 Pessoas | Operadores |
| 📝 Utilitários | Observações |