Vortxlink Developers API

Integre o poder do roteamento neural e encurtamento de links diretamente na sua infraestrutura. Crie campanhas em massa e extraia dados analíticos via API RESTful.

Autenticação

A API utiliza tokens Bearer para autenticar requisições. Você pode gerar a sua chave de API na página de configurações do seu painel.

HEADER
Authorization: Bearer vx_live_SUA_CHAVE_AQUI

psychology Instruções para IA (AI Agents) Novo

Se você utiliza assistentes de inteligência artificial (como ChatGPT, Claude ou agentes autônomos) para desenvolver ou gerenciar sua infraestrutura, copie o prompt de instruções abaixo para que a IA possa interagir diretamente com a API do Vortxlink de maneira otimizada.

smart_toy Prompt do Sistema para Agentes IA 
Você é um agente de inteligência artificial encarregado de gerenciar a infraestrutura de links inteligentes do usuário na API do Vortxlink.
Utilize as especificações abaixo para formular as requisições REST necessárias em nome do usuário.

### Autenticação
Toda requisição deve conter o cabeçalho de autenticação utilizando a chave de API do usuário:
Authorization: Bearer <sua_chave_aqui>

### 1. Listar Links (Read)
- Método: GET
- Rota: /api/links
- Parâmetros Opcionais (Query):
  - workspace_id: <int>

### 2. Criar um Smart Link (Create)
- Método: POST
- Rota: /api/links
- Payload JSON:
{
  "workspace_id": <int>,
  "fallback_url": "<url_destino_padrao>",
  "domain_id": null,
  "name": "<nome_da_campanha>", // Opcional
  "ios_url": "<url_iOS>", // Opcional
  "android_url": "<url_Android>" // Opcional
}

### 3. Atualizar um Smart Link (Update)
- Método: PUT
- Rota: /api/links/<link_id>
- Payload JSON: (quaisquer campos que deseja alterar, como name, fallback_url, ios_url, etc.)

### 4. Excluir um Smart Link (Delete)
- Método: DELETE
- Rota: /api/links/<link_id>

### 5. Extrair Estatísticas de Tráfego (Analytics)
- Método: GET
- Rota: /api/stats
- Parâmetros Opcionais (Query):
  - link_id: <int>
  - workspace_id: <int>

Responda sempre com clareza técnica e formule as requisições exatas quando solicitado.

table_chart Exportação de Leads & Relatórios (n8n / CRM / Webhooks)

Extraia os dados dos leads capturados e o histórico bruto de cliques em JSON ou CSV para integração automatizada com n8n, Make.com, Zapier ou seu CRM.

GET /api/reports/export

Query Parameters

Parâmetro Tipo Descrição
type String leads (dados dos leads capturados) ou clicks (logs de tráfego). Padrão: clicks.
format String json ou csv. Padrão: json.
start / end String Datas no formato ISO YYYY-MM-DD (opcional).
link_id Integer / String ID do link ou all para incluir todos os links.

Exemplo de Resposta (JSON - type=leads)

[
  {
    "created_at": "2026-08-14T15:30:00Z",
    "link_name": "Campanha Instagram",
    "lead_name": "Maria Oliveira",
    "lead_email": "maria@cliente.com",
    "lead_phone": "1199887766",
    "device": "iPhone (iOS)",
    "ip": "179.198.112.8"
  }
]

Analytics & Stats

Obtenha métricas de cliques, geolocalização e dispositivos.

GET /api/stats
Parâmetro Tipo Descrição
link_id Integer (Opcional) ID do link específico. Se omitido, retorna os stats gerais da conta.
workspace_id Integer (Opcional) Filtra os analytics por um Workspace específico.

code Exemplos de Integração (cURL, Python, Node.js)

Copie e cole trechos de código prontos para integrar a API do Vortxlink a outros sistemas.

cURL

curl -X POST https://vortxlink.pro/api/links \
  -H "Authorization: Bearer vx_live_SUA_CHAVE_AQUI" \
  -H "Content-Type: application/json" \
  -d '{
    "workspace_id": 1,
    "name": "Campanha Promoção",
    "fallback_url": "https://suaempresa.com",
    "lead_gate_enabled": true,
    "lead_gate_logo_url": "https://suaempresa.com/logo.png"
  }'

Python (Requests)

import requests

API_KEY = "vx_live_SUA_CHAVE_AQUI"
headers = {"Authorization": f"Bearer {API_KEY}", "Content-Type": "application/json"}

# Listar os leads capturados via API
response = requests.get("https://vortxlink.pro/api/reports/export?type=leads&format=json", headers=headers)
leads = response.json()
print("Leads capturados:", leads)