Documentação da API
Crie, gerencie e baixe as análises dos seus links de forma programática com a REST API do Quik.mn.
Todos os serviços
Todos os produtos da plataforma Quik.mn: pela REST API e na web.
URL base
Todos os endpoints partem da seguinte URL base:
Autenticação
Em cada requisição, inclua a chave de API do seu painel no cabeçalho Authorization da seguinte forma:
Não compartilhe sua chave com ninguém. Se ela vazar, gere outra no painel.
Lista de endpoints
Parâmetros
POST /api/v1/links — campos do body:
GET /api/v1/links — parâmetros de query:
Formato de erro
Todo erro retorna um código de status HTTP (401, 404, 409, 422, 429) e uma estrutura JSON padronizada:
{ "error": "alias_taken", "message": "Esse alias está reservado ou já em uso." }
Códigos comuns: unauthorized (401), not_found (404), alias_taken (409), invalid_url / invalid_alias / invalid_expires_at / invalid_starts_at (422), rate_limited (429).
Limites de uso
Exemplo de requisição
Exemplo em cURL para criar um link curto:
curl -X POST https://quik.mn/api/v1/links \
-H "Authorization: Bearer qk_live_xxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{
"url": "https://exemplo.com/caminho/muito/longo",
"alias": "promo",
"title": "Campanha de primavera",
"expires_at": "2026-12-31 23:59:59"
}'
Webhook
Cadastre um endpoint na seção Webhook do painel e enviaremos um POST com JSON para a sua URL sempre que um evento selecionado acontecer. Uma resposta 2xx conta como sucesso; caso contrário, tentamos de novo até 3 vezes, com intervalos de 1 min a 10 min. Depois de 10 falhas seguidas, o webhook é desativado automaticamente.
Estrutura de cada envio (exemplo):
{
"event": "link.created",
"created_at": "2026-07-18T09:30:00+00:00",
"data": {
"link": {
"id": 42, "slug": "promo", "short_url": "https://quik.mn/promo",
"long_url": "https://exemplo.com/caminho/muito/longo", "title": "Campanha de primavera",
"clicks": 0, "active": true, "state": "ok",
"created_at": "2026-07-18 09:30:00", "expires_at": "2027-07-18 09:30:00"
}
}
}
Verificar a assinatura
Cada envio chega com estes cabeçalhos: X-Quik-Event (o nome do evento), X-Quik-Signature — sha256=HMAC_SHA256(body, secret). O secret é exibido uma única vez, na criação do webhook. Verifique SEMPRE a assinatura sobre o corpo bruto (raw) da requisição, usando comparação de tempo constante:
<?php
// PHP — verifique a assinatura sobre o corpo bruto (raw) da requisição
$payload = file_get_contents('php://input');
$signature = $_SERVER['HTTP_X_QUIK_SIGNATURE'] ?? '';
$expected = 'sha256=' . hash_hmac('sha256', $payload, $secret);
if (!hash_equals($expected, $signature)) {
http_response_code(401);
exit('invalid signature');
}
$event = json_decode($payload, true);
// $event['event'], $event['data'] ...
http_response_code(200);
// Node.js (Express) — verifique a assinatura sobre o corpo bruto (raw) da requisição
const crypto = require('crypto');
app.post('/quik-webhook', express.raw({ type: 'application/json' }), (req, res) => {
const signature = req.get('X-Quik-Signature') || '';
const expected = 'sha256=' +
crypto.createHmac('sha256', secret).update(req.body).digest('hex');
const a = Buffer.from(expected), b = Buffer.from(signature);
if (a.length !== b.length || !crypto.timingSafeEqual(a, b)) {
return res.status(401).send('invalid signature');
}
const event = JSON.parse(req.body); // event.event, event.data ...
res.sendStatus(200);
});
Limites: 1 webhook no Free, 3 no Pro e 10 no Business. O endpoint precisa ser uma URL http/https acessível publicamente (endereços de rede interna são bloqueados).
