🚀 Documentação da API SADIONLINE¶

Plataforma de Análise de Engajamento de Estudantes Powered by IA

Rastreamento de engajamento em tempo real através de visão computacional e machine learning

🎯 Bem-vindo ao SADIONLINE¶

Bem-vindo à API SADIONLINE - a plataforma mais avançada de análise de engajamento de estudantes powered by inteligência artificial e visão computacional. Nossa plataforma fornece insights em tempo real sobre a dinâmica da sala de aula, ajudando educadores e instituições a otimizar experiências de aprendizagem através de métricas de engajamento baseadas em dados.

O que é o SADIONLINE?¶

O SADIONLINE é uma plataforma abrangente que aproveita tecnologias de ponta de visão computacional e machine learning para analisar o engajamento de estudantes em tempo real. Ao processar streams de vídeo de câmeras da sala de aula, nossos algoritmos de IA detectam e analisam vários indicadores comportamentais incluindo:

• Níveis de atenção através de detecção de pose e rastreamento ocular
• Estados emocionais via análise de expressão facial
• Padrões comportamentais como uso de telefone, bocejo e sonolência
• Métricas de participação e pontuações de engajamento

Principais Recursos¶

✨ Análise em Tempo Real - Rastreamento de engajamento ao vivo durante as aulas 📊 Métricas Abrangentes - Análises detalhadas e relatórios 🔒 Integração Segura - Segurança de nível empresarial com autenticação por chave API 🌍 Suporte Multi-idioma - Disponível em Português, Inglês e Espanhol 📱 Integração Fácil - API RESTful com documentação abrangente 🎯 Atividades Personalizadas - Suporte para vários tipos de atividades de aprendizagem

🚀 Primeiros Passos¶

Pré-requisitos¶

• Conta SADIONLINE válida com acesso à API
• Chave API para autenticação
• Cliente HTTP (Postman, curl, ou qualquer linguagem de programação)

Base URL¶

https://api.sadionline.com

Autenticação¶

Todas as requisições da API requerem autenticação usando uma chave API. Inclua sua chave API no cabeçalho Authorization:

Authorization: APIKey sk_sua_chave_api_aqui

Como Usar sua Chave API¶

Sua chave API é fornecida pela equipe do SADIONLINE quando você obtém acesso à plataforma. A chave deve ser mantida segura e nunca compartilhada publicamente.

Formato da Chave API: - Prefixo: sk_ - Exemplo: sk_abc123def456ghi789jkl012mno345pqr678

⚠️ Importante: Mantenha sua chave API segura e nunca a compartilhe publicamente. As chaves API são prefixadas com sk_ seguidas por uma string aleatória segura.

🌍 Internacionalização¶

O SADIONLINE suporta múltiplos idiomas e locales. Você pode especificar seu idioma preferido usando o cabeçalho Accept-Language:

Accept-Language: pt-br
Accept-Language: en-us
Accept-Language: es-es

Idiomas Suportados¶

Localização de Respostas¶

Todas as respostas da API serão localizadas baseadas no cabeçalho Accept-Language que você fornecer. Mensagens de erro, descrições de campos e outros conteúdos de texto serão retornados no idioma especificado.

📚 Visão Geral dos Endpoints da API¶

Recursos Principais¶

Nossa API é organizada em torno dos seguintes recursos principais que os integradores tipicamente usam:

Formato de Resposta¶

Todas as respostas da API seguem um formato JSON consistente:

{
  "success": true,
  "message": "Operação concluída com sucesso",
  "data": {
    // Dados da resposta aqui
  },
  "timestamp": "2024-01-15T10:30:00Z"
}

Tratamento de Erros¶

Respostas de erro incluem informações detalhadas:

{
  "success": false,
  "message": "Erro de validação ocorreu",
  "errors": {
    "nome_do_campo": ["Descrição do erro"]
  },
  "timestamp": "2024-01-15T10:30:00Z"
}

📖 Guia de Início Rápido¶

1. Criar um Estudante¶

POST /tenant/{organization_id}/v1/students/
Authorization: APIKey sk_sua_chave_api_aqui
Content-Type: application/json
Accept-Language: pt-br

{
  "registration_code": "EST001",
  "email": "estudante@exemplo.com",
  "status": "ACTIVE",
  "entry_date": "2024-01-15"
}

2. Criar uma Atividade¶

POST /tenant/{organization_id}/v1/activities/
Authorization: APIKey sk_sua_chave_api_aqui
Content-Type: application/json

{
  "name": "Aula de Matemática",
  "description": "Sessão de cálculo avançado",
  "type": "CLASS"
}

3. Conectar WebSocket para Streaming¶

const ws = new WebSocket('wss://ws.sadionline.com.br/v1/stream/?student_id={student_id}&activity_id={activity_id}&organization_id={organization_id}&api_key={api_key}');

4. Listar Sessões¶

GET /tenant/{organization_id}/v1/sessions/
Authorization: APIKey sk_sua_chave_api_aqui

5. Obter Análise de Engajamento¶

GET /tenant/{organization_id}/v1/sessions/{session_id}/engagement/summary/
Authorization: APIKey sk_sua_chave_api_aqui

🔧 Limites de Taxa¶

Para garantir uso justo e estabilidade do sistema, as requisições da API são limitadas por taxa:

• Endpoints padrão: 1000 requisições por hora
• Análise de engajamento: 100 requisições por hora
• Conexões WebSocket: 1 conexão simultânea por estudante

Cabeçalhos de limite de taxa são incluídos nas respostas:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1642248000

📞 Suporte¶

Precisa de ajuda? Estamos aqui para ajudá-lo:

• Documentação: https://docs.sadionline.com
• Email de Suporte: suporte@sadionline.com
• Página de Status: https://status.sadionline.com