Pular para o conteúdo principal

Logs de Integrações

Toda requisição de escrita feita pela API é registrada automaticamente como um log de integração. Esses registros permitem acompanhar o histórico de sincronizações, identificar falhas e auditar o uso da integração.

Como acessar os logs

Os logs podem ser acessados de duas formas:

  • Plataforma ProExtend: acesse em Avançado > Integrações para visualizar e filtrar os logs diretamente no painel administrativo.
  • API de Integração: consuma os endpoints GET /sync-logs e GET /sync-logs/{id} para integrar os logs a ferramentas externas como dashboards, sistemas de monitoramento ou planilhas.
informação

Os endpoints de logs estão disponíveis para consulta na API de integração. Para detalhes de parâmetros e resposta, acesse a documentação da API.

Acessar API →

Operações registradas

Um log é gerado automaticamente a cada requisição de escrita. Requisições de leitura (GET) não geram log.

OperaçãoDescriçãoEndpoint
SincronizaçãoCriação e atualização de entidadesPOST /{entidade}/sync
RemoçãoExclusão de registrosDELETE /{entidade}/{code}
MatrículaVínculo e desvinculo de alunos em turmasPOST /enrollments/{code}/students/{studentCode}
SSOGeração e revogação de tokens de acessoPOST /sso/generate-token, POST /sso/revoke-token

Retenção dos logs

Cada log é armazenado com base na sua data de criação e fica disponível por 30 dias corridos, após os quais é removido automaticamente.

Log criado em:   2026-05-01
Disponível até: 2026-05-31 ✓
Removido em: 2026-06-01 ✗
Log criado em:   2026-05-15
Disponível até: 2026-06-14 ✓
Removido em: 2026-06-15 ✗

Como filtrar os logs

Tanto no painel quanto na API, os logs podem ser filtrados pelos critérios abaixo. Combine vários filtros para reduzir o resultado (por exemplo, falhas de sincronização de alunos em um período).

FiltroDescriçãoExemplo
Chave de integraçãoRestringe aos logs de uma API Key específicapex_a1b2c3...
EntidadeTipo de entidade da operaçãoprofessors, students, enrollments
MétodoVerbo HTTP da requisiçãoPOST, DELETE
StatusResultado da operaçãosucesso ou erro
PeríodoIntervalo de datas de criação do log2026-05-01 a 2026-05-31
informação

Os nomes exatos dos parâmetros de query (GET /sync-logs) e os valores aceitos estão documentados no playground interativo, onde é possível montar e testar a requisição.

Acessar API →

Exemplos de resposta

Dados sensíveis

Campos como cpf, password e api_key são substituídos por [REDACTED] antes de ser armazenados.