Skip to main content

​
Workspace e API Key

Cada chave de API pertence a um workspace. Todas as rotas /v1/short-links usam esse vínculo automaticamente. Não envie x-workspace-id na API v1.

​
Escopos disponíveis

EscopoUso típico
short_links:readGET /v1/short-links, GET /v1/short-links/:id, GET .../analytics, GET .../clicks
short_links:managePOST /v1/short-links, PATCH /v1/short-links/:id, DELETE /v1/short-links/:id
Uma integração que só consulta dashboards ou relatórios pode usar apenas short_links:read. Já criação, edição de destino, desativação ou remoção exige short_links:manage (sozinho ou junto com read, conforme você preferir na mesma chave).

​
Erros comuns

  • 403 Missing scope: short_links:read — a chave não tem leitura de links curtos.
  • 403 Missing scope: short_links:manage — tentativa de POST / PATCH / DELETE sem escopo de gestão.
  • 403 com mensagem de links desativados no workspace — ative o recurso em Configurações do workspace antes de chamar POST.

​
Relação com outros canais

Encurtar links automaticamente no envio de SMS, WhatsApp, etc. não substitui os escopos desses canais (sms:send, whatsapp:send, …). Os escopos desta página valem apenas para o prefixo /v1/short-links.