Documentação da API SOAR

Bem-vindo à documentação oficial da API SOAR. Esta interface RESTful foi projetada para oferecer integração robusta, segura e modular com aplicações externas, utilizando o framework CodeIgniter 4, autenticação via JWT e envio de e-mails via SendGrid.

Toda a API retorna dados em formato JSON e exige o cabeçalho Content-Type: application/json. Para endpoints protegidos, também é necessário incluir o cabeçalho Authorization: Bearer {token}.

🔐 Autenticação

Endpoints relacionados ao processo de autenticação de usuários, recuperação de senha entre outros.

Login
Registro
Esqueci minha senha
Verificar código OTP
Redefinir senha
Logout

📦 Endpoints disponíveis

Cada módulo representa uma funcionalidade da plataforma e está sendo documentado gradualmente.

Usuários – Cadastro, listagem e gerenciamento de usuários.
Organizações – Administração das organizações vinculadas aos usuários.
Perfil – Acesso e edição dos dados do usuário autenticado.