Referência API REST

Autenticação

A API ClicAven usa chaves API para autenticação. Cada pedido deve incluir a sua chave no cabeçalho Authorization.

Comment obtenir une clé API

1. Connectez-vous à votre compte ClicAven et accédez à la page Clés API
2. Donnez un nom à votre clé et cliquez sur Créer
3. Copiez la clé affichée — elle ne sera plus visible ensuite

Headers necessários

Authorization: Bearer ca_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

POST/api/links

Cria um novo link curto. Requer uma chave API válida.

Headers necessários

Authorization: Bearer ca_votre_cle_api
Content-Type: application/json

Body do pedido

{
  "url": "https://example.com/une-url-tres-longue"
}

Resposta (201 Created)

{
  "id": 42,
  "short_code": "aB3xYz",
  "short_url": "https://clicaven.com/aB3xYz",
  "original_url": "https://example.com/une-url-tres-longue",
  "clicks": 0,
  "created_at": "2026-04-18T12:00:00+00:00"
}

Exemplo curl

curl -s -X POST https://clicaven.com/api/links \
  -H "Authorization: Bearer ca_votre_cle_api" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/page-longue?utm_source=api"}'

GET/api/links

Lista todos os seus links curtos. Requer uma chave API válida.

Exemplo curl

curl -s https://clicaven.com/api/links \
  -H "Authorization: Bearer ca_votre_cle_api" | jq .

Resposta (200 OK)

[
  {
    "id": 42,
    "short_code": "aB3xYz",
    "short_url": "https://clicaven.com/aB3xYz",
    "original_url": "https://example.com/page-longue",
    "clicks": 14,
    "created_at": "2026-04-18T12:00:00+00:00"
  }
]

GET/api/links/{id}

Obtém os detalhes de um link específico, incluindo o contador de cliques.

Exemplo curl

curl -s https://clicaven.com/api/links/42 \
  -H "Authorization: Bearer ca_votre_cle_api" | jq .

Resposta (200 OK)

{
  "id": 42,
  "short_code": "aB3xYz",
  "short_url": "https://clicaven.com/aB3xYz",
  "original_url": "https://example.com/page-longue",
  "clicks": 14,
  "created_at": "2026-04-18T12:00:00+00:00"
}

DELETE/api/links/{id}

Elimina definitivamente um link. O redirecionamento ficará imediatamente inativo. Esta ação é irreversível.

Exemplo curl

curl -s -X DELETE https://clicaven.com/api/links/42 \
  -H "Authorization: Bearer ca_votre_cle_api"
# → 204 No Content (sucesso, sem body)

6. Códigos de erro

Formato de erro

{
  "error": "authentication_failed",
  "message": "Invalid or expired API key."
}

Exemplos PHP e JavaScript

Não precisa de SDK: a API é uma simples API REST JSON. Eis exemplos prontos a copiar para as linguagens mais comuns.

PHP

<?php
// ClicAven API — PHP example (no SDK needed)
$apiKey = 'ca_votre_cle_api';
$url    = 'https://example.com/une-url-tres-longue';

$ch = curl_init('https://clicaven.com/api/links');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST           => true,
    CURLOPT_HTTPHEADER     => [
        'Authorization: Bearer ' . $apiKey,
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode(['url' => $url]),
]);

$response = json_decode(curl_exec($ch), true);
curl_close($ch);

echo $response['shortUrl'];
// => https://clicaven.com/aB3xYz

JavaScript (Node.js / fetch)

const API_KEY = 'ca_votre_cle_api';

const res = await fetch('https://clicaven.com/api/links', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ url: 'https://example.com/une-url-tres-longue' }),
});

const link = await res.json();
console.log(link.shortUrl);
// => https://clicaven.com/aB3xYz

Link com slug personalizado (Pro+)

curl -s -X POST https://clicaven.com/api/links \
  -H "Authorization: Bearer ca_votre_cle_api" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/promo","customSlug":"ma-promo"}'

{
  "id": 43,
  "short": "rT9kWm",
  "customSlug": "ma-promo",
  "shortUrl": "https://clicaven.com/ma-promo",
  "url": "https://example.com/promo",
  "clickCount": 0,
  "createdAt": "2026-04-25T14:00:00+00:00"
}

Os slugs personalizados requerem um plano Pro ou superior. 3 a 60 caracteres, letras, números e hífenes.