Documentação

API Reference v1

Tudo que você precisa para integrar o Inovgest Short à sua aplicação.

Autenticação

Todas as requisições devem incluir o header de autenticação com sua API key.

Authorization: Bearer sk_live_sua_api_key

Base URL

https://api.inovgest.com

Endpoints

POST/api/v1/links

Criar link curto

Cria um novo link encurtado a partir de uma URL longa.

Request Body

{
  "url": "https://exemplo.com/pagina-muito-longa",
  "slug": "meu-link",       // opcional
  "expiresAt": "2026-12-31"  // opcional
}

Response

{
  "id": "clk_abc123",
  "shortUrl": "https://invgst.com/meu-link",
  "originalUrl": "https://exemplo.com/pagina-muito-longa",
  "createdAt": "2026-02-21T10:00:00Z"
}

GET/api/v1/links/:id

Obter link

Retorna os detalhes de um link específico.

Response

{
  "id": "clk_abc123",
  "shortUrl": "https://invgst.com/meu-link",
  "originalUrl": "https://exemplo.com/...",
  "clicks": 1247,
  "createdAt": "2026-02-21T10:00:00Z"
}

GET/api/v1/links

Listar links

Lista todos os links do usuário com paginação.

Response

{
  "data": [...],
  "pagination": {
    "page": 1,
    "perPage": 20,
    "total": 342
  }
}

PATCH/api/v1/links/:id

Atualizar link

Atualiza propriedades de um link existente.

Request Body

{
  "slug": "novo-slug",
  "expiresAt": "2027-01-01"
}

Response

{
  "id": "clk_abc123",
  "shortUrl": "https://invgst.com/novo-slug",
  "updatedAt": "2026-02-21T12:00:00Z"
}

DELETE/api/v1/links/:id

Excluir link

Remove permanentemente um link e seus dados de analytics.

Response

{ "deleted": true }

GET/api/v1/links/:id/stats

Estatísticas

Retorna analytics detalhados de um link.

Response

{
  "clicks": 1247,
  "uniqueVisitors": 891,
  "topCountries": ["BR", "US", "PT"],
  "topDevices": ["mobile", "desktop"],
  "clicksByDay": [...]
}