API Reference

Documentação da API Link

Use a API para criar links curtos, consultar links existentes e ler métricas da sua conta. A chave fica no dashboard.

Base URL

https://link.guidev.site

Formato

JSON

Auth

X-API-Key

Auth

Autenticação

As integrações devem enviar a API key gerada no dashboard. A chave pode ir em `X-API-Key` ou no header `Authorization` como Bearer.

cURL

curl https://link.guidev.site/api/dashboard \
  -H "X-API-Key: link_sua_api_key"

Guarde sua chave como segredo. Links criados com a API key ficam vinculados à sua conta e aparecem no dashboard.

POST

/api/links

Cria um link curto randômico ou customizado.

POST/api/links

API key recomendada

Campo	Tipo	Obrigatório	Descrição
url	string	Sim	URL original. Se não tiver protocolo, assume https://.
slug	string	Não	Slug customizado com 3 a 48 caracteres: letras, números, _ ou -.
customSlug	string	Não	Alias de slug para clientes que preferem esse nome.

cURL

curl -X POST https://link.guidev.site/api/links \
  -H "Content-Type: application/json" \
  -H "X-API-Key: link_sua_api_key" \
  -d "{\"url\":\"https://guidev.site\",\"slug\":\"portfolio\"}"

JSON

{
  "id": "4f5b1d1a-7f26-4e49-9f4d-1f6b10e7725d",
  "slug": "portfolio",
  "url": "https://guidev.site/",
  "shortUrl": "https://link.guidev.site/portfolio",
  "clicks": 0
}

GET

/api/links/{slug}

Consulta os dados públicos de um link pelo slug.

GET/api/links/{slug}

Público

cURL

curl https://link.guidev.site/api/links/portfolio

JSON

{
  "slug": "portfolio",
  "url": "https://guidev.site/",
  "shortUrl": "https://link.guidev.site/portfolio",
  "clicks": 12,
  "createdAt": "2026-05-18T18:00:00.000Z"
}

GET

/api/dashboard

Retorna resumo, links, rankings de origem/localização e os eventos recentes do usuário autenticado.

GET/api/dashboard

API key obrigatória

cURL

curl https://link.guidev.site/api/dashboard \
  -H "X-API-Key: link_sua_api_key"

JSON

{
  "user": { "id": "user-id", "email": "voce@email.com" },
  "apiKey": "link_sua_api_key",
  "summary": { "links": 3, "clicks": 42, "trackedEvents": 42 },
  "links": [],
  "countries": [],
  "locations": [],
  "referrers": [],
  "recentEvents": [],
  "baseUrl": "https://link.guidev.site"
}

GET

/api/stats

Retorna a contagem global de links criados. Este endpoint é público e tem cache curto.

GET/api/stats

Público

JSON

{ "links": 128 }

GET

/{slug}

Abre o link encurtado, registra o evento quando possível e redireciona para a URL original.

GET/portfolio

Público

O redirect incrementa `clicks` e tenta salvar país, região, cidade, referrer e user agent com base nos headers da hospedagem.

Reference

Erros e limites

400

URL inválida ou slug fora do formato aceito.

401

API key ausente, inválida ou usuário não autenticado.

404

Link ou endpoint não encontrado.

409

Slug customizado já está em uso.

500

Erro inesperado no servidor ou no Supabase.

503

Não foi possível gerar um slug randômico único.