v1.0.0

Documentação da API

Bem-vindo à referência oficial do BP-LinkUtils. Nossa API permite criar links curtos inteligentes, gerenciar redirecionamentos e coletar métricas detalhadas de acesso programaticamente.

Nota de Portfólio: Esta documentação demonstra como o sistema funciona "por baixo do capô". A interface web (Dashboard) consome exatamente esses mesmos endpoints.

Criar Link Curto

Gera uma URL encurtada com opções avançadas de personalização e segurança.

POST /api/shorten JSON

curl -X POST https://bpso.com.br/projetos/bp-linkutils/api/shorten \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://bpso.com.br/projetos",
    "custom_slug": "meu-portfolio",
    "password": "senha-secreta",
    "expires_at": "2026-12-31 23:59:00"
  }'

Parâmetros

Campo	Tipo	Descrição
url	string	A URL original de destino. (Obrigatório)
custom_slug	string	Personalize o final da URL (ex: `/promocao`).
password	string	Define uma senha para proteger o link.
expires_at	datetime	Data de expiração (YYYY-MM-DD HH:MM).

Password Gate

Implementamos uma camada de middleware no redirecionamento. Quando um link possui senha, o servidor interrompe o fluxo e renderiza uma view de autenticação temporária.

A senha é armazenada usando password_hash() (Bcrypt) e nunca é exposta em texto plano. A validação ocorre via sessão PHP.

Exemplo de Resposta (Erro de Senha)

HTTP/1.1 200 OK (Renderiza View)
<div class="error">Senha incorreta.</div>

UTM Builder Integrado

O sistema concatena automaticamente os parâmetros de rastreamento do Google Analytics antes de encurtar a URL.

utm_source (ex: google, newsletter)
utm_medium (ex: cpc, email)
utm_campaign (ex: lancamento_inverno)