Documentação da API

API REST completa para encurtamento e gerenciamento de links. Autenticação via token, suporte a slugs personalizados e operações CRUD.

Autenticação

Todas as requisições devem incluir o header X-API-Token com seu token pessoal.

Exemplo:

X-API-Token: seu_token_aqui

Tokens são gerados automaticamente no seu perfil. A API precisa estar habilitada globalmente ou para seu usuário.

POST

Criar Link

https://l4y.ovh/api?action=shorten

Exemplo de Requisição:

curl -X POST \
  -H "Content-Type: application/json" \
  -H "X-API-Token: SEU_TOKEN_AQUI" \
  -d '{"url":"https://exemplo.com","slug":"meu-link"}' \
  https://l4y.ovh/api?action=shorten

Resposta (201):

{
  "slug": "meu-link",
  "short_url": "https://l4y.ovh/meu-link"
}

Erro (422):

{"error": "Slug já em uso"}
GET

Listar Links

https://l4y.ovh/api?action=list

Exemplo de Requisição:

curl -H "X-API-Token: SEU_TOKEN_AQUI" \
  https://l4y.ovh/api?action=list

Resposta (200):

{
  "links": [
    {
      "id": 123,
      "slug": "abc123",
      "original_url": "https://exemplo.com",
      "short_url": "https://l4y.ovh/abc123",
      "is_custom": false,
      "user_id": 1,
      "created_at": "2024-11-25 12:00:00",
      "updated_at": "2024-11-25 12:00:00"
    }
  ]
}

Admin: Use ?all=1 para listar todos os links do sistema.

PUT

Atualizar Link

https://l4y.ovh/api?action=update

Exemplo de Requisição:

curl -X PUT \
  -H "Content-Type: application/json" \
  -H "X-API-Token: SEU_TOKEN_AQUI" \
  -d '{"id":123,"url":"https://novo.com","slug":"novo-slug"}' \
  https://l4y.ovh/api?action=update

Resposta (200):

{
  "slug": "novo-slug",
  "short_url": "https://l4y.ovh/novo-slug"
}
DELETE

Deletar Link

https://l4y.ovh/api?action=delete&id=123

Exemplo de Requisição:

curl -X DELETE \
  -H "X-API-Token: SEU_TOKEN_AQUI" \
  "https://l4y.ovh/api?action=delete&id=123"

Resposta (200):

{"status": "ok"}

Regras e Permissões

  • Seu usuário deve estar verificado e com API habilitada (ou API global ativa).
  • Usuários só podem editar/deletar seus próprios links personalizados.
  • Links automáticos (numéricos) só podem ser deletados por administradores.
  • Administradores têm acesso total: podem listar, editar e deletar qualquer link.

Comece a usar a API agora!

Seu token está disponível na página de perfil.

Acessar Meu Perfil