> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notifique.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick Start

> Crie um link curto, consulte analytics e liste cliques.

<Tip>
  **read** = listar e analytics. **manage** = criar, editar, remover. Ative links curtos no workspace antes do `POST`.
</Tip>

## Em poucas palavras

* `POST /v1/short-links` cria o link
* `GET .../analytics` e `GET .../clicks` medem desempenho
* Auth: `Authorization: Bearer sk_live_...`

Escopos: [Escopos da API Key](/short-links-api/como-funciona/escopos-da-api-key).

***

## 1. Criar link

#### 1A, Pelo painel

**Add-ons → Links curtos** → novo link → URL de destino (e código customizado, se quiser).

#### 1B, Pela API

Escopo: **`short_links:manage`**.

```bash theme={null}
curl -sS -X POST 'https://api.notifique.dev/v1/short-links' \
  -H 'Authorization: Bearer sk_live_...' \
  -H 'Content-Type: application/json' \
  -d '{"targetUrl":"https://example.com/oferta","customCode":null}'
```

Resposta: `shortUrl`, `id`, `code`.

***

## 2. Listar links

Escopo: **`short_links:read`**.

```bash theme={null}
curl -sS 'https://api.notifique.dev/v1/short-links?page=1&limit=20' \
  -H 'Authorization: Bearer sk_live_...'
```

Filtro opcional: `&source=API`, `MANUAL` ou `AUTO`.

***

## 3. Analytics

Últimos **7 dias** por hora (padrão). Para por dia: `granularity=day`.

```bash theme={null}
curl -sS 'https://api.notifique.dev/v1/short-links/LINK_ID/analytics?granularity=day' \
  -H 'Authorization: Bearer sk_live_...'
```

***

## 4. Listar cliques

```bash theme={null}
curl -sS 'https://api.notifique.dev/v1/short-links/LINK_ID/clicks?page=1&limit=50' \
  -H 'Authorization: Bearer sk_live_...'
```

***

## 5. Pausar ou remover

```bash theme={null}
curl -sS -X PATCH 'https://api.notifique.dev/v1/short-links/LINK_ID' \
  -H 'Authorization: Bearer sk_live_...' \
  -H 'Content-Type: application/json' \
  -d '{"isActive":false}'
```

```bash theme={null}
curl -sS -X DELETE 'https://api.notifique.dev/v1/short-links/LINK_ID' \
  -H 'Authorization: Bearer sk_live_...'
```

***

## Próximos passos

* [Smart Links e conversões](/short-links-api/como-funciona/smart-links-e-conversoes)
* [Eventos de webhooks](/short-links-api/como-funciona/eventos-do-webhooks)
* [Introdução](/short-links-api/como-funciona/introducao)