API Arah - Lógica de Negócio e Usabilidade
Documento de Negócio Completo
Versão: 2.0
Data: 2025-01-20
Última Atualização: 2025-01-20 (Reorganizado em subdocumentos)
📋 Índice da Documentação da API
Este documento foi reorganizado em subdocumentos para melhor navegação e manutenção. Cada seção principal está documentada em seu próprio arquivo.
📚 Documentos por Categoria
🎯 Fundamentos e Configuração
- Visão Geral e Princípios - Princípios fundamentais, segurança, rate limiting
- Paginação - Padrão de paginação em todos os endpoints
- Verificações e Evidências - Sistema de upload/download de evidências
🔐 Autenticação e Identidade
- Autenticação e Cadastro - Login social, tokens JWT
🗺️ Territórios e Vínculos
- Territórios - Listagem, busca, seleção de territórios
- Vínculos e Membros (Memberships) - VISITOR, RESIDENT, verificação de residência
📝 Conteúdo e Interação
- Feed Comunitário - Posts, curtidas, comentários, compartilhamentos
- Eventos - Criação, listagem, participação em eventos
- Mídias em Conteúdo - Imagens, vídeos e áudios em posts, eventos, marketplace, chat
🗺️ Mapa e Recursos
- Mapa Territorial - Entidades do mapa, pins, confirmações
- Alertas de Saúde - Alertas públicos de saúde
- Assets (Recursos Territoriais) - Recursos compartilhados do território
💰 Economia e Marketplace
- Marketplace - Loja territorial, itens, carrinho, checkout, payout
💬 Comunicação
- Chat - Canais, grupos, mensagens diretas, mídias no chat
- Notificações - Sistema de notificações push e in-app
🛡️ Moderação e Administração
- Moderação - Sistema de moderação e reports
- Solicitações de Entrada (Join Requests) - Solicitações de residência
- Admin: System Config e Work Queue - Configurações globais e filas de trabalho
⚙️ Configurações e Regras
- Feature Flags - Sistema de feature flags por território
- Regras de Visibilidade e Permissões - Regras de acesso e visibilidade de conteúdo
- Preferências de Usuário - Configurações e preferências do usuário
- Governança Comunitária - Interesses, votações, caracterização, histórico de participação
📊 Referência Rápida
- Resumo de Endpoints Principais - Lista consolidada de todos os endpoints
🎯 Backend for Frontend (BFF)
- Avaliação BFF ⭐ - Avaliação estratégica completa da API BFF
- Avaliação BFF - Resumo 📋 - Resumo executivo para decisão rápida
- Contrato OpenAPI BFF 📄 - Contrato OpenAPI 3.0.3 completo (v2/journeys)
- Resumo de Contratos BFF 📝 - Referência rápida dos contratos BFF
- Guia de Implementação Frontend 💻 - Guia completo para frontend
- Exemplo Flutter Completo 📱 - Exemplo completo em Flutter/Dart
- Quick Start Flutter 🚀 - Exemplo mínimo para começar
- Coleção Postman BFF 🧪 - Coleção Postman completa
- Guia de Uso Postman 📖 - Guia de uso da coleção Postman
Nota: A API BFF (v2) expõe operações em forma de jornadas (user journeys), reduzindo significativamente o número de chamadas necessárias. A API v1 continua disponível e funcional.
🚀 Como Usar Esta Documentação
Para Desenvolvedores
- Comece pela Visão Geral para entender os princípios fundamentais
- Configure Autenticação para obter tokens JWT
- Explore Territórios para entender o contexto territorial
- Consulte Paginação para listagens
- Use o Resumo de Endpoints como referência rápida
Para Integradores
- Consulte o DevPortal (
devportal.Arah.app/) para exemplos práticos de código - Use o OpenAPI Explorer (
devportal.Arah.app/#openapi) para explorar contratos - Veja os Diagramas de Sequência (
devportal.Arah.app/#fluxos) para entender fluxos
Para Analistas Funcionais
- Veja a Wiki - Visão do Produto para entender a visão estratégica
- Consulte a Wiki - Modelo de Domínio para entender a arquitetura
- Explore os User Stories para casos de uso detalhados
📖 Links Relacionados
- DevPortal:
devportal.Arah.app/- Portal de desenvolvedor com exemplos práticos - Wiki:
devportal.Arah.app/wiki/- Documentação completa do projeto - GitHub:
github.com/sraphaz/Arah- Código-fonte - API BFF: Avaliação BFF | Contrato OpenAPI | Exemplo Flutter - API v2 com jornadas otimizadas
Última Atualização: 2025-01-20
Versão da API: v1
Status: Produção