REST API

Base URL: https://urlik.xyz/api/. Responses are JSON of the form:

{ "status": "success", "message": "...", "return": { ... } }

Authentication (optional for basic shortening) — the X-Api-Key header. Your key is in your account. Links created with a key are attached to your account.

Endpoints

POST /api/getLink.json

Create a short link.

ParameterRequiredDescription
urlrequiredtarget URL (http/https)
aliasoptionalcustom code, 2–32 chars [a-zA-Z0-9_-]
modeoptionalredirect (default), preview, frame
expireoptionallifetime in seconds (0 = never)
passwordoptionalpassword to follow the link
curl -X POST https://urlik.xyz/api/getLink.json \
 -H "X-Api-Key: YOUR_KEY" \
 -d "url=https://example.com/very/long/path" \
 -d "mode=redirect"
{ "status":"success", "return":{
 "hex":"a1b2c3", "url":"https://urlik.xyz/a1b2c3",
 "qr":"https://urlik.xyz/qr/a1b2c3.png",
 "stats":"https://urlik.xyz/a1b2c3+", "mode":"redirect" } }

POST /api/stats.json

Stats for a link. The code parameter is the short code. Returns the click count, a daily series, sources, devices and browsers.

POST /api/links.json

List your links. Requires X-Api-Key.

POST /api/update.json

Update a link (code + fields url, mode, expire, password). Requires a key/session.

POST /api/delete.json

Delete a link (code). Requires X-Api-Key or the owner's session.

Media downloader, QR codes and temporary email

These methods require the X-Api-Key header (your key is in your account) or a call through RapidAPI.

MethodParametersDescription
GET /api/download.jsonurl*download video/photo from 1000+ sites (TikTok, YouTube, Instagram…): returns formats with ready signed download links (MP4/MP3/image)
GET /api/qr.jsondata*, format, fg, bg, ecc, sizeQR code: format = png/svg, colors fg/bg
GET /api/mailbox.jsonaddress or usernameget or create a temporary address
GET /api/messages.jsonaddresslist messages in a temporary inbox
GET /api/message.jsonaddress, idread a single message

Experimentar ao vivo

Explore e chame cada endpoint aqui mesmo. Cole a sua chave de API no botão Authorize para fazer pedidos autenticados.

Incorporar o encurtador

Cole este excerto em qualquer página para adicionar um encurtador de URL funcional com ligação para urlik.xyz:

<iframe src="https://urlik.xyz/embed" style="width:100%;max-width:520px;height:150px;border:0" title="URL shortener by urlik.xyz" loading="lazy"></iframe>

/embed ↗

Uma API REST simples para links curtos

A API REST do Urlik permite criar, ler, atualizar e eliminar links curtos a partir do seu próprio código e obter estatísticas de cliques em JSON. É uma API HTTPS simples — envia um pedido POST e recebe uma resposta JSON previsível — por isso funciona a partir de qualquer linguagem ou plataforma.

O encurtamento básico não precisa de credenciais. Para associar links à sua conta e os gerir mais tarde, envie a sua chave no cabeçalho X-Api-Key, que encontra na sua conta. As respostas seguem sempre a mesma estrutura — status, message e return — mostrada abaixo.

Preciso de uma chave API?

Não para o encurtamento básico — pode criar um link de forma anónima. Uma chave, disponível na sua conta, associa os links a si e é necessária para os listar, atualizar ou eliminar.

Em que formato são as respostas?

Cada endpoint devolve JSON com um status, uma message legível e um objeto return que contém os dados, por isso o processamento é consistente em todas as chamadas.

Há um limite de pedidos?

Sim, os pedidos têm limites por utilizador para manter o serviço rápido e justo. As chaves autenticadas têm um limite mais alto do que o tráfego anónimo.

Posso usá-la a partir de qualquer linguagem?

Sim. É uma API JSON HTTPS padrão, por isso qualquer coisa que consiga enviar um pedido POST — curl, Python, PHP, JavaScript ou Go — pode usá-la.

A que pesquisas esta página responde