Documentação da API

Devolve a identidade da conta. É o endpoint para verificar se a chave está válida. Resposta achatada, sem envelope — integrações como Zapier montam o rótulo da conexão a partir dos campos de primeiro nível.

{
  "id": "0f8c…",
  "email": "voce@exemplo.com.br",
  "plan": "pro"
}

Cria um link curto.

Corpo

{
  "url": "https://loja.exemplo.com.br/promocao",
  "custom_code": "promo",
  "title": "Black Friday — Instagram"
}

Resposta 201

{
  "data": {
    "id": "9a1f…",
    "short_code": "promo",
    "short_url": "https://klyk.app.br/promo",
    "destination_url": "https://loja.exemplo.com.br/promocao",
    "title": "Black Friday — Instagram",
    "is_active": true,
    "created_at": "2026-08-01T12:00:00.000Z"
  },
  "error": null
}

Erros

• 400 — url ausente ou inválida, ou custom_code fora do formato aceito
• 403 — limite de links do mês atingido, ou plano sem API
• 409 — já existe um link com esse custom_code

O limite de links é por mês corrido, não vitalício: ele reabre no dia 1º. Links já criados nunca deixam de funcionar por causa do limite.

Lista os seus links, do mais recente para o mais antigo.

Parâmetros de consulta

Resposta 200

{
  "data": [ { "id": "9a1f…", "short_code": "promo", "short_url": "…",
              "destination_url": "…", "title": "…", "is_active": true,
              "total_clicks": 1204, "created_at": "…" } ],
  "total": 47,
  "limit": 20,
  "offset": 0,
  "error": null
}

A resposta repete a lista em links e a paginação em pagination. São campos de compatibilidade com integrações antigas — em código novo, use data, total, limit e offset.

Lê um link só, pelo id. É o endpoint para saber o estado atual de algo que você criou antes, sem precisar listar a conta inteira.

{
  "data": {
    "id": "9a1f…",
    "short_code": "promo",
    "short_url": "https://klyk.app.br/promo",
    "destination_url": "https://loja.exemplo.com.br/promocao",
    "title": "Black Friday — Instagram",
    "is_active": true,
    "total_clicks": 1204,
    "created_at": "2026-08-01T12:00:00.000Z"
  },
  "error": null
}

Link que não existe e link que não é seu respondem a mesma coisa: 404. Distinguir os dois contaria a um estranho que aquele id existe.

Altera o destino, o nome interno ou o estado do link. Só os campos enviados mudam.

{
  "destination_url": "https://loja.exemplo.com.br/nova-pagina",
  "is_active": false
}

Responde 200 com o link atualizado no envelope data, ou 404 se o link não for seu.

destination também é aceito como nome do campo de destino, por compatibilidade.

Apaga o link. Responde 204, sem corpo.

Os cliques de um link, agregados. O parâmetro period aceita 7d, 30d, 90d ou all — o padrão é 30d.

{
  "data": {
    "total_clicks": 1204,
    "unique_clicks": 843,
    "by_country": { "BR": 1102, "PT": 61, "unknown": 41 },
    "by_device":  { "mobile": 890, "desktop": 300, "tablet": 14 },
    "by_source":  { "instagram.com": 700, "direct": 504 }
  },
  "error": null,
  "meta": { "linkId": "9a1f…", "period": "30d" }
}

As chaves de by_source são o domínio de origem, sem www.; quem chegou sem origem conhecida cai em direct. O período é limitado pela retenção do seu plano.

Inscreve uma URL. Sem o campo de eventos, ela recebe todos.

{
  "url": "https://sua-url/callback",
  "events": ["link.created", "link.clicked"]
}

Responde 201 com a inscrição em data, incluindo o id usado para cancelar depois. URLs que apontam para a rede interna são recusadas com 400.

event no singular, com um texto só, também é aceito — é a convenção de REST Hook que o Zapier usa.

Lista as inscrições da conta em data: id, url, events, active e datas. O segredo de assinatura não é devolvido.

Cancela a inscrição. Responde 204, sem corpo.