Skip to main content
Esta página é para quem vai ligar um sistema (site, CRM, automação) ao Notifique para criar e consultar links curtos pela API. Se você só usa o painel, pode criar e acompanhar links por lá; a API é opcional.

​
Antes de começar

Você vai precisar de:
  • Uma chave de API criada no workspace certo. Cada chave já pertence a um workspace: a API usa isso automaticamente. Não envie o cabeçalho x-workspace-id (ele não é usado na v1 e, se vier preenchido, a API responde 400).
  • Permissões na chave para ler e/ou gerenciar links curtos (escopos short_links:read e short_links:manage).
  • Os links curtos ativos nas configurações desse workspace (senão criação e uso podem falhar conforme a regra do produto).
  • A URL base da API do seu ambiente; nos exemplos usamos https://api.notifique.dev — troque se a sua for outra.
Substitua sk_live_... pela sua chave real. Gera um link curto apontando para a página que você quiser. 
curl -sS -X POST 'https://api.notifique.dev/v1/short-links' \
  -H 'Authorization: Bearer sk_live_...' \
  -H 'Content-Type: application/json' \
  -d '{"targetUrl":"https://example.com/oferta","customCode":null}'
Se der certo, a resposta traz o endereço curto (shortUrl), o id do link e o código usado na URL. 
curl -sS 'https://api.notifique.dev/v1/short-links?page=1&limit=20' \
  -H 'Authorization: Bearer sk_live_...'
Dá para filtrar por origem do link, por exemplo: &source=API, MANUAL ou AUTO. Use o id que veio na criação ou na listagem no lugar de LINK_ID. 
curl -sS 'https://api.notifique.dev/v1/short-links/LINK_ID' \
  -H 'Authorization: Bearer sk_live_...'

​
4. Ver números (gráficos na API)

Por padrão mostra os últimos 7 dias, contagem por hora. Para ver por dia, use granularity=day. 
curl -sS 'https://api.notifique.dev/v1/short-links/LINK_ID/analytics?granularity=day' \
  -H 'Authorization: Bearer sk_live_...'
Opcional: start e end em formato de data/hora internacional (ISO 8601) para limitar o período.

​
5. Listar cada clique

Do mais novo para o mais antigo, com paginação. 
curl -sS 'https://api.notifique.dev/v1/short-links/LINK_ID/clicks?page=1&limit=50' \
  -H 'Authorization: Bearer sk_live_...'

​
6. Desativar ou mudar o destino

Exemplo: parar de redirecionar sem apagar o histórico. 
curl -sS -X PATCH 'https://api.notifique.dev/v1/short-links/LINK_ID' \
  -H 'Authorization: Bearer sk_live_...' \
  -H 'Content-Type: application/json' \
  -d '{"isActive":false}'
O link some das listagens normais e deixa de redirecionar quem ainda tiver o endereço antigo. 
curl -sS -X DELETE 'https://api.notifique.dev/v1/short-links/LINK_ID' \
  -H 'Authorization: Bearer sk_live_...'

​
Continuar

  • Escopos — o mínimo de permissão para cada ação