Portal de Transparência ICA

Manual do Usuário

Gerenciamento de Documentos

• Upload de documentos
• Organização em categorias
• Controle de versões
• Compartilhamento

Perfil e Configurações

• Edição de perfil
• Preferências de notificação
• Histórico de atividades

Permissões e Acessos

• Níveis de acesso
• Compartilhamento de documentos
• Gestão de grupos

Webhooks

O sistema permite integração via webhooks para notificações em tempo real.

Eventos Disponíveis

• user.created - Quando um novo usuário é criado
• user.updated - Quando um usuário é atualizado
• document.uploaded - Quando um documento é enviado

Formato do Payload

{
  "event": "document.uploaded",
  "data": {
    "id": 123,
    "title": "Documento.pdf",
    "user_id": 456
  },
  "timestamp": 1648847847
}

Segurança

Cada webhook possui um secret_token único para validação via HMAC SHA-256.

O header X-Webhook-Signature deve ser validado para garantir a autenticidade.

API

A API REST permite integração programática com o sistema.

Autenticação

Utilize o header X-API-KEY com sua chave de API para autenticação.

Endpoints

Documentos

• GET /api/v1/documents - Lista documentos
• POST /api/v1/documents - Upload de documento
• GET /api/v1/documents/{id} - Detalhes do documento
• DELETE /api/v1/documents/{id} - Remove documento

Usuários

• GET /api/v1/users - Lista usuários
• POST /api/v1/users - Cria usuário
• GET /api/v1/users/{id} - Detalhes do usuário
• PUT /api/v1/users/{id} - Atualiza usuário

Categorias

• GET /api/v1/categories - Lista categorias
• POST /api/v1/categories - Cria categoria
• PUT /api/v1/categories/{id} - Atualiza categoria

Limites de Requisição

• 100 requisições por minuto por IP
• Upload máximo de 50MB por arquivo
• Máximo de 1000 registros por página