API e webhooks: o URLHop trabalhando dentro do seu sistema

Criar 300 QR Codes à mão para o catálogo novo? Trocar destino por destino quando o site muda? Deixe o seu sistema fazer isso. Com uma chave de API, ele cria links e QR Codes, troca destinos e consulta estatísticas. Com webhooks, o URLHop avisa as suas ferramentas quando algo acontece.

Ver a documentação da API →

Quando fazer à mão deixa de dar conta

Uma loja com centenas de produtos, uma imobiliária que cadastra imóveis todo dia, uma agência que cuida de dezenas de clientes. Em algum momento, criar e atualizar links pelo painel vira trabalho repetitivo, e trabalho repetitivo gera erro. A API do URLHop faz o mesmo que o painel, só que a partir do seu sistema, da sua planilha ou da sua ferramenta de automação. Os webhooks fazem o caminho inverso: avisam você quando algo muda.

O que dá para fazer com a API

A API do URLHop é REST, responde em JSON e tem uma referência pública no formato OpenAPI. Com ela, você cria, edita e apaga links curtos; troca o destino de um QR Code já impresso; baixa o QR Code; importa até 200 links de uma vez por CSV; organiza links em pastas e tags; gerencia páginas de link na bio; e consulta as estatísticas de cada link. As regras de plano do painel valem também pela API: por exemplo, colocar senha num link exige o Pro, e exportar os eventos brutos de estatísticas em JSON exige o Business.

Webhooks: o URLHop avisa quando algo acontece

Cadastre um endereço HTTPS e escolha os eventos. A cada evento, o URLHop envia um POST com os dados em JSON, assinado com HMAC-SHA256 para você confirmar que a mensagem veio de nós. Se o seu sistema estiver fora do ar, o envio é repetido por até 9 horas, e o painel mostra o histórico de entregas. Os eventos são: link criado, editado ou apagado (link.created, link.updated, link.deleted); limite de cliques atingido (link.click_limit_reached); página de link na bio criada, editada ou apagada (tree.created, tree.updated, tree.deleted); domínio verificado (domain.verified); e 80% ou 100% dos cliques medidos do mês (usage.threshold_reached). Funciona com qualquer ferramenta que recebe webhooks, como n8n, Make ou Zapier.

Exemplos reais de uso

Como equipes ligam o URLHop às ferramentas que já usam.

Quem usa e o que acontece

Como começar

Em poucos minutos você faz a primeira chamada.

Passo a passo

Em qual plano está

A API e os webhooks estão no plano Starter e nos planos acima, e também no teste grátis de 30 dias do Pro que toda conta nova recebe, sem cartão. Alguns recursos seguem o plano: links com senha e exportação das estatísticas em CSV são do Pro; exportação dos eventos brutos em JSON pela API é do Business. Se a conta voltar para o Free, as chaves de API param de funcionar até você assinar de novo, mas nenhum link é desativado.

Testar a API grátis por 30 dias

Perguntas sobre a API e os webhooks

O URLHop tem API?

Sim. O URLHop tem uma API REST pública, com referência OpenAPI em app.urlhop.me/api/v1/docs/, para criar e editar links curtos, baixar QR Codes, importar links por CSV, gerenciar páginas de link na bio e consultar estatísticas. Ela está disponível a partir do plano Starter e no teste grátis de 30 dias do Pro.

Como funciona a autenticação da API?

Com chaves de API criadas em Configurações → API. Cada chave é mostrada uma única vez, vale só para o espaço de trabalho em que foi criada e vai no cabeçalho Authorization: Bearer. O limite é de 120 requisições por minuto por chave, e você pode revogar uma chave quando quiser.

Quais eventos os webhooks do URLHop enviam?

link.created, link.updated, link.deleted, link.click_limit_reached, tree.created, tree.updated, tree.deleted, domain.verified e usage.threshold_reached, este quando a conta chega a 80% e a 100% dos cliques medidos do mês. Cada entrega é um POST em JSON assinado com HMAC-SHA256.

Como sei que o webhook veio mesmo do URLHop?

Cada entrega traz o cabeçalho X-URLHop-Signature, com um horário e uma assinatura HMAC-SHA256 calculada sobre o horário e o corpo da mensagem, usando o segredo que aparece quando você cria o webhook. Recalcule a assinatura no seu servidor e recuse entregas antigas ou que não batem. A documentação traz um exemplo pronto.

O URLHop funciona com n8n, Make ou Zapier?

Sim, por meio de webhooks e da API. Qualquer ferramenta que recebe webhooks pode tratar os eventos do URLHop, e qualquer ferramenta que faz requisições HTTP pode usar a API com uma chave. Não são integrações oficiais com essas plataformas, e sim recursos abertos que funcionam com elas.

E se o meu servidor estiver fora do ar quando um evento acontecer?

O URLHop tenta de novo depois de 1 minuto, 5 minutos, 30 minutos, 2 horas e 6 horas, e o painel mostra cada entrega e o status dela. Seu servidor deve responder com um código 2xx em até 5 segundos. Um endereço é desativado depois de 50 falhas seguidas.