API pública.

Todas as requests precisam incluir uma API Key no header Authorization. API Keys estão disponíveis exclusivamente no plano Business.

Gere sua key em Dashboard → API.

Authorization: Bearer lks_sua_api_key_aqui

https://greedy-bat-366.convex.site

Request body

{
  "url": "https://example.com/minha-pagina-muito-longa",
  "title": "Minha Página"  // opcional
}

Response (201)

{
  "data": {
    "id": "k97f9ja122...",
    "shortCode": "kPOYCu",
    "shortUrl": "https://linkshort.com.br/kPOYCu",
    "originalUrl": "https://example.com/minha-pagina-muito-longa"
  }
}

Exemplos

curl -X POST https://greedy-bat-366.convex.site/api/v1/links \
  -H "Authorization: Bearer lks_sua_key" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com"}'

const res = await fetch("https://greedy-bat-366.convex.site/api/v1/links", {
  method: "POST",
  headers: {
    "Authorization": "Bearer lks_sua_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ url: "https://example.com" }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://greedy-bat-366.convex.site/api/v1/links",
    headers={"Authorization": "Bearer lks_sua_key"},
    json={"url": "https://example.com"},
)
data = res.json()

Query params

Response (200)

{
  "data": [
    {
      "id": "k97f9ja122...",
      "shortCode": "kPOYCu",
      "shortUrl": "https://linkshort.com.br/kPOYCu",
      "originalUrl": "https://example.com",
      "clicks": 42,
      "createdAt": 1712620800000
    }
  ],
  "meta": { "total": 42, "limit": 20, "offset": 0 }
}

Retorna detalhes completos do link incluindo estatísticas básicas (top 5 países, dispositivos e navegadores).

Response (200)

{
  "data": {
    "id": "k97f9ja122...",
    "shortCode": "kPOYCu",
    "shortUrl": "https://linkshort.com.br/kPOYCu",
    "originalUrl": "https://example.com",
    "title": "Minha Página",
    "clicks": 42,
    "isActive": true,
    "createdAt": 1712620800000,
    "stats": {
      "totalClicks": 42,
      "topCountries": [{ "key": "BR", "count": 30 }],
      "topDevices":   [{ "key": "mobile", "count": 25 }],
      "topBrowsers":  [{ "key": "Chrome", "count": 28 }]
    }
  }
}

Soft delete — marca o link como inativo. Redirecionamentos passam a retornar 410 Gone. Os dados ficam preservados pra histórico.

Response (200)

{ "data": { "ok": true } }

Limite de 100 requests por minuto por API Key.

Formato do erro

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid API key"
  }
}