Documentação da API SOAR
Bem-vindo à documentação oficial da API SOAR. Uma interface RESTful robusta e segura para integração com aplicações externas...
Informações Técnicas
Tecnologias
- Framework: CodeIgniter 4
- Autenticação: JWT (JSON Web Tokens)
- E-mail: SendGrid
- Formato: JSON
Cabeçalhos Obrigatórios
Módulos da API
Autenticação
Gerenciamento de usuários e segurança da aplicação
- • Login e registro
- • Recuperação de senha
- • Verificação OTP
- • Logout
Usuários
Gestão completa de usuários e perfis
- • CRUD de usuários
- • Convites e promoções
- • Atribuição de praticantes
- • Exportação de dados
Organizações
Administração de organizações e empresas
- • Criação e edição
- • Busca e listagem
- • Exportação CSV
- • Gestão de membros
Grupos
Organização de usuários em grupos
- • Criação de grupos
- • Adição de membros
- • Gestão de permissões
- • Exportação de dados
Eventos
Gestão de eventos e atividades
- • Criação de eventos
- • Edição e exclusão
- • Busca e filtros
- • Exportação CSV
Avaliações
Sistema de avaliações e relatórios
- • Início de avaliações
- • Listagem de questões
- • Geração de relatórios
- • Indicadores
Dashboard
Métricas e indicadores da plataforma
- • Usuários por mês
- • Licenças por mês
- • Vendas e indicadores
- • Relatórios gerenciais
Cupons
Sistema de cupons e descontos
- • Criação de cupons
- • Atribuição a usuários
- • Gestão de validade
- • Relatórios de uso
Comunicação
Gestão de parágrafos e conteúdo
- • Criação de parágrafos
- • Edição de conteúdo
- • Busca e filtros
- • Exportação de dados
Upload de Imagens
Gestão de arquivos e imagens
- • Upload de perfil
- • Capas de eventos
- • Exclusão de arquivos
- • Validação de tipos
Suporte
Sistema de atendimento ao cliente
- • Envio de mensagens
- • Tickets de suporte
- • Histórico de atendimento
- • Categorização
IA Chat
Chat inteligente via WebSocket
- • Comunicação em tempo real
- • Processamento de IA
- • Histórico de conversas
- • Integração WSS
Usuários Convidados
Gestão de usuários temporários
- • Registro temporário
- • Validação OTP
- • Promoção para individual
- • Cálculos de avaliação
Começando
1. Autenticação
Comece fazendo login ou registrando um novo usuário para obter seu token de acesso.
Ver documentação de autenticação2. Primeiros Endpoints
Explore os endpoints básicos como usuários, perfil e organizações para entender o funcionamento.
Ver lista de usuáriosDicas para Explorar a Documentação
- Utilize o menu lateral para navegar entre os módulos e endpoints disponíveis.
- Consulte exemplos de requisições e respostas para facilitar a integração.
- Verifique os códigos de status HTTP retornados para identificar rapidamente erros ou sucessos.
- Leia atentamente as descrições dos parâmetros obrigatórios e opcionais de cada endpoint.