API Reference

A API do LIP fornece endpoints RESTful para integração com aplicações externas.

Autenticação

Todas as requisições à API requerem autenticação via token JWT.

Obter Token

Resposta:

Usar Token

Inclua o token no header de autorização:

Endpoints

Users

Listar Usuários

Query Parameters:

Parâmetro	Tipo	Descrição
page	number	Número da página (padrão: 1)
limit	number	Itens por página (padrão: 10)
search	string	Busca por nome ou email
role	string	Filtrar por função

Resposta:

Criar Usuário

Resposta:

Atualizar Usuário

Deletar Usuário

Content

Listar Conteúdos

Resposta:

Criar Conteúdo

Analytics

Obter Estatísticas

Query Parameters:

Parâmetro	Tipo	Descrição
startDate	date	Data inicial (ISO 8601)
endDate	date	Data final (ISO 8601)
metrics	string[]	Métricas desejadas

Resposta:

Códigos de Status

Código	Descrição
200	Sucesso
201	Criado com sucesso
204	Sucesso sem conteúdo
400	Requisição inválida
401	Não autenticado
403	Não autorizado
404	Recurso não encontrado
422	Validação falhou
429	Muitas requisições
500	Erro interno do servidor

Rate Limiting

A API possui limite de requisições:

Plano Free: 100 requisições/hora
Plano Pro: 1000 requisições/hora
Plano Enterprise: Ilimitado

Headers de resposta:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1705329600

Webhooks

Configure webhooks para receber eventos em tempo real.

Eventos Disponíveis

user.created
user.updated
user.deleted
content.published
content.updated

Configurar Webhook

Payload do Webhook

SDKs

JavaScript/TypeScript

Python

Exemplos Práticos

Busca Avançada

Upload de Arquivos

Exportação de Dados

Versionamento

A API usa versionamento via URL:

v1: /api/v1/users (atual)
v2: /api/v2/users (beta)

Mantenha-se atualizado sobre mudanças através do changelog.

Próximos Passos

CLI - Interface de linha de comando
Webhooks - Configuração avançada de webhooks
Variáveis de Ambiente - Configuração do ambiente

Última atualização

26 de novembro de 2025