PixelEdu Public API

Acesso público a dados agregados e anonimizados

Integre o PixelEdu em seus aplicativos com endpoints seguros e documentados.

Autenticação

Todos os endpoints protegidos requerem uma chave de API no header:

x-api-key: YOUR_API_KEY

📝 Sua chave de API para este ambiente:

Rate Limiting

100 requisições

por minuto

Dados Retornados

100% anonimizado

sem dados pessoais

Endpoints Disponíveis

GETPúblico

Documentação da API

Acesse a documentação completa com todos os endpoints disponíveis

Caminho:

GET /docs

Exemplo:

curl https://pixeledu.com.br/api/public/docs

Resposta:

{
  "title": "PixelEdu Public API",
  "version": "1.0.0",
  "endpoints": {}
}
GETPúblico

Health Check

Verifica se a API está operacional

Caminho:

GET /health

Exemplo:

curl https://pixeledu.com.br/api/public/health

Resposta:

{
  "status": "ok",
  "timestamp": "2026-03-04T12:00:00Z",
  "version": "1.0.0"
}
GET Protegido

Estatísticas de Perguntas

Retorna o número total de perguntas por disciplina (dados anonimizados)

Caminho:

GET /stats/questions

Exemplo:

curl -H "x-api-key: YOUR_API_KEY" https://pixeledu.com.br/api/public/stats/questions

Resposta:

{
  "total": 1250,
  "byDiscipline": {
    "mathematics": 350,
    "physics": 280,
    "chemistry": 200
  },
  "lastUpdated": "2026-03-04T12:00:00Z"
}
GET Protegido

Índice de Engajamento

Retorna métricas agregadas de engajamento da comunidade

Caminho:

GET /stats/engagement

Exemplo:

curl -H "x-api-key: YOUR_API_KEY" https://pixeledu.com.br/api/public/stats/engagement

Resposta:

{
  "averageEngagement": 0.72,
  "totalInteractions": 5430,
  "avgAnswersPerQuestion": 2.8,
  "avgViewsPerQuestion": 18.5,
  "totalQuestions": 1250,
  "totalAnswers": 3500,
  "totalViews": 23125
}
GET Protegido

Tags Populares

Retorna as tags mais usadas (máximo 100)

Caminho:

GET /stats/tags?limit=20

Parâmetros de Query:

limit - Número máximo de tags (1-100) (padrão: 20)

Exemplo:

curl -H "x-api-key: YOUR_API_KEY" "https://pixeledu.com.br/api/public/stats/tags?limit=30"

Resposta:

{
  "total": 342,
  "limit": 30,
  "tags": [
    {
      "tag": "algebra",
      "count": 145
    },
    {
      "tag": "geometry",
      "count": 138
    },
    {
      "tag": "trigonometry",
      "count": 125
    }
  ],
  "lastUpdated": "2026-03-04T12:00:00Z"
}
GET Protegido

Estatísticas de Materiais

Retorna o número de materiais por tipo (resumo, prova, exercício, etc.)

Caminho:

GET /stats/materials

Exemplo:

curl -H "x-api-key: YOUR_API_KEY" https://pixeledu.com.br/api/public/stats/materials

Resposta:

{
  "total": 850,
  "byType": {
    "resumo": 250,
    "prova": 350,
    "exercicio": 200,
    "slides": 50
  },
  "lastUpdated": "2026-03-04T12:00:00Z"
}
GET Protegido

Crescimento (7 dias)

Retorna as métricas de crescimento dos últimos 7 dias

Caminho:

GET /stats/growth

Exemplo:

curl -H "x-api-key: YOUR_API_KEY" https://pixeledu.com.br/api/public/stats/growth

Resposta:

{
  "period": "7 days",
  "questionsAdded": 45,
  "materialsAdded": 30,
  "newEngagements": 150,
  "totalAdded": 225,
  "lastUpdated": "2026-03-04T12:00:00Z"
}

Boas Práticas

  • •Implemente cache no seu lado para reduzir requisições
  • •Monitore o rate limit - ajuste suas requisições conforme necessário
  • •Nunca exponha sua API key no frontend - sempre use um proxy no backend
  • •Dados são anonimizados - nenhuma informação pessoal é retornada
  • •Trate erros 429 com exponential backoff

Precisa de ajuda? Visite nosso suporte ou documentação