Documentação da API

Integre o encurtador de URL ly1.ru em suas aplicações com nossa simples API REST.

🔐 Autenticação Necessária

O acesso à API requer autenticação. Entre com Google para obter sua chave API. Entrar

Autenticação

Todas as requisições da API requerem autenticação usando sua chave API. Inclua-a no cabeçalho:

Authorization: Bearer YOUR_API_KEY

Ou use o cabeçalho X-API-Key :

X-API-Key: YOUR_API_KEY

Endpoints

POST /api/v1/shorten

Criar uma URL encurtada.

Parâmetros da Requisição

Parâmetro	Tipo	Descrição
url obrigatório	string	A URL a encurtar (deve ser uma URL HTTP/HTTPS válida)
custom opcional	string	Alias personalizado (3-32 caracteres alfanuméricos)

Exemplo de Requisição

# Using curl
curl -X POST https://ly1.ru/api/v1/shorten \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/very/long/url", "custom": "mylink"}'

# Using PHP
$ch = curl_init('https://ly1.ru/api/v1/shorten');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_API_KEY',
        'Content-Type: application/json'
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'url' => 'https://example.com/very/long/url',
        'custom' => 'mylink'
    ])
]);
$response = json_decode(curl_exec($ch), true);

Resposta de Sucesso (200)

{
  "success": true,
  "data": {
    "code": "mylink",
    "short_url": "https://ly1.ru/mylink",
    "subdomain_url": "https://mylink.ly1.ru",
    "original_url": "https://example.com/very/long/url"
  }
}

Resposta de Erro (400/401)

{
  "success": false,
  "error": "Error message here"
}

Códigos de Erro

Code	Descrição
`400`	Requisição Inválida — Parâmetros ou URL inválidos
`401`	Não Autorizado — Chave API inválida ou ausente
`405`	Método Não Permitido — Use POST
`500`	Erro Interno do Servidor

Limites de Taxa

Atualmente não há limites rígidos, mas seja razoável. Requisições excessivas podem resultar em bloqueio temporário.