POST /links/{linkId}/preview

API · v1 · Homologação · Revisado em 2026-10-20 · Markdown

Simular destino por cenário sem gerar clique nem fazer redirect. Contrato v1 · disponível em produção e homologação · operação previewLinksLinkId. Guia funcional · Índice · Schemas · Testar em sandbox.

Autenticação e efeito

Permissão: links:preview. Sessão humana ou chave de servidor limitada ao proprietário e aos aplicativos autorizados. OAuth/MCP ainda não estão disponíveis. Uma chave de exemplo deve incluir somente esta permissão e as leituras necessárias ao seu fluxo, restrita a app_loja; emita-a na área autenticada de desenvolvedores.

Disponível em produção e homologação; sujeito às capacidades do app e à configuração do provedor. OAuth só será aceito após B1b. Campos desconhecidos rejeitados. Consulte os ADRs para regras semânticas além do JSON Schema.

O efeito é autenticado, auditado e pode gerar publicação eventual e eventos do recurso. Links/domínios/templates podem precisar de propagação antes de aparecerem publicamente. Não muda identidade de link implicitamente. Dependências e capabilities podem bloquear a ação. O status confirma a persistência descrita, sem prometer propagação global imediata.

Parâmetros

Nome	Local	Obrigatório	Tipo e restrições
`linkId`	path	sim	LinkId; {“type”:“string”,“maxLength”:500,“pattern”:“^[a-z0-9.-]+~~-(?:(?!~~-)[A-Za-z0-9._-])*-(?:(?!~~-)[A-Za-z0-9._~~-])+$”}
`Idempotency-Key`	header	sim	UUID v4 por intenção. Recibo por 24h. Mudança de payload/precondição retorna 409. Segredo de chave não é reexibido. IdempotencyKey; {“type”:“string”,“maxLength”:36,“pattern”:“^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$”}

Corpo e semântica

Content-Type: application/json. Campos desconhecidos são rejeitados no envelope.

Campo	Tipo	Obrigatório	Significado e limites
`at`	AnalyticsInstant	não	Valor tipado; formato e restrições completos no schema abaixo.
`country`	string	não	Valor tipado; formato e restrições completos no schema abaixo. Formato validado pelo schema
`platform`	desktop / android / ios	sim	Valor tipado; formato e restrições completos no schema abaixo.
`source`	browser / social	não	Valor tipado; formato e restrições completos no schema abaixo.

Omitir campos opcionais usa o default documentado ou preserva o valor em PATCH. null só é aceito nos campos cujo schema permite null, com efeito de limpar/desvincular indicado no guia. Arrays enviados substituem a coleção quando o endpoint define atualização completa; não implicam merge. Identificadores/owner/app de um recurso existente não são transferidos por PATCH. Herança de templates/UTMs segue o guia, sem alterar links anteriores por cópia automática.

Request mínimo

{
  "platform": "android"
}

Request completo de referência

{
  "platform": "android",
  "source": "browser"
}

cURL

AGILINK_API_KEY deve ficar no servidor. Os placeholders abaixo são fictícios. Preserve Idempotency-Key e payload ao repetir uma intenção após timeout.

curl --request POST 'https://api.staging.agilink.io/v1/links/go.example.com~-ofertas~-tenis/preview' \
  --header 'Authorization: Bearer <credencial>' \
  --header 'Idempotency-Key: 10000000-0000-4000-8000-000000000001' \
  --header 'Content-Type: application/json' \
  --data '{"platform":"android","source":"browser"}'

JavaScript / TypeScript

// Node.js 22+. Defina AGILINK_API_KEY no ambiente do servidor.
const response = await fetch('https://api.staging.agilink.io/v1/links/go.example.com~-ofertas~-tenis/preview', {
  method: 'POST',
  headers: {
  "Authorization": `Bearer ${process.env.AGILINK_API_KEY}`,
  "Idempotency-Key": "10000000-0000-4000-8000-000000000001",
  "Content-Type": "application/json"
},
  body: JSON.stringify({
  "platform": "android",
  "source": "browser"
}),
  redirect: 'error', signal: AbortSignal.timeout(30000)
});
if (!response.ok) throw new Error('HTTP '+response.status+' requestId='+response.headers.get('X-Request-Id'));
const result = await response.json();
console.log(result);

Python

# Python 3.10+; pip install requests
import os
import requests
headers = {
  "Authorization": "Bearer " + os.environ["AGILINK_API_KEY"],
  "Idempotency-Key": "10000000-0000-4000-8000-000000000001"
}
response = requests.request(
    'POST', 'https://api.staging.agilink.io/v1/links/go.example.com~-ofertas~-tenis/preview',
    headers=headers, json={"platform":"android","source":"browser"},
    timeout=30, allow_redirects=False)
if not 200 <= response.status_code < 300:
    raise RuntimeError(f'HTTP {response.status_code}; requestId={response.headers.get("X-Request-Id")}')
result = response.json()
print(result)

Response 200

Sucesso. Exemplo fictício.

Header	Significado	Exemplo
`X-Request-Id`	Identificador gerado pelo servidor, inclusive para falhas e replays.	conforme resposta
`Cache-Control`	Respostas administrativas não podem ser armazenadas.	no-store, no-transform
`ETag`	Revisão forte, a enviar em If-Match na alteração.	“20000000-0000-4000-8000-000000000001”

{
  "data": {
    "state": "active",
    "allowed": true,
    "matchedRuleId": null,
    "evaluatedAt": "2026-10-19T20:00:00Z",
    "linkId": "go.example.com~-ofertas~-tenis",
    "appId": "app_loja",
    "platform": "android",
    "mode": "android",
    "nativeUrl": "loja://produtos/tenis",
    "fallbackUrl": "https://shop.example.com/",
    "opening": "manual",
    "publication": {
      "status": "pending",
      "desiredRevision": "20000000-0000-4000-8000-000000000001",
      "confirmedRevision": null,
      "updatedAt": "2026-10-19T20:00:00Z"
    },
    "sideEffects": false
  },
  "meta": {
    "requestId": "req_00000000000040008000000000000001"
  }
}

Campo	Tipo	Obrigatório	Significado e limites
`data`	LinkPreviewResult	sim	Resultado tipado da operação.
`data.state`	active / paused / scheduled / expired	sim	Estado atual do recurso.
`data.allowed`	boolean	sim	Valor tipado; formato e restrições completos no schema abaixo.
`data.matchedRuleId`	string ou null	sim	Valor tipado; formato e restrições completos no schema abaixo.
`data.evaluatedAt`	string	sim	Valor tipado; formato e restrições completos no schema abaixo. date-time
`data.linkId`	LinkId	sim	Identidade composta do link.
`data.appId`	AppId	sim	Aplicativo proprietário; precisa estar autorizado.
`data.platform`	desktop / android / ios	sim	Valor tipado; formato e restrições completos no schema abaixo.
`data.mode`	web / android / ios / recovery	sim	Valor tipado; formato e restrições completos no schema abaixo.
`data.nativeUrl`	string ou null	sim	Valor tipado; formato e restrições completos no schema abaixo.
`data.fallbackUrl`	string ou null	sim	Valor tipado; formato e restrições completos no schema abaixo.
`data.opening`	manual / automatic	sim	Valor tipado; formato e restrições completos no schema abaixo.
`data.publication`	object	sim	Confirmação eventual da projeção pública.
`data.publication.status`	pending / synced / failed	sim	Estado atual; consulte as transições no guia do recurso.
`data.publication.desiredRevision`	string	sim	Valor tipado; formato e restrições completos no schema abaixo. uuid
`data.publication.confirmedRevision`	string ou null	sim	Valor tipado; formato e restrições completos no schema abaixo.
`data.publication.updatedAt`	string	sim	Instante da última alteração. date-time
`data.sideEffects`	objeto	sim	Valor tipado; formato e restrições completos no schema abaixo.
`meta`	object	sim	Correlação e informações da resposta.
`meta.requestId`	RequestId	sim	Identificador de correlação gerado pelo servidor.

Falhas, revisão e repetição

Idempotency-Key UUID v4 é obrigatório, por intenção e credencial, por 24 horas. Em resultado incerto, repita exatamente o mesmo método, URL, corpo, revisão e chave. Alterar a intenção exige nova chave. Segredos de emissão não são reexibidos. Esta operação não exige If-Match. Não faça retry automático ilimitado.

Status	Significado
400	Cabeçalho, query, cursor ou JSON inválido.
401	Credencial inválida, expirada ou revogada.
403	Operação sem permissão ou capacidade desabilitada.
404	Recurso inexistente ou fora dos aplicativos autorizados.
409	Conflito de identidade/idempotência; operação em andamento ou segredo já exibido.
413	Corpo excede o limite.
415	Content-Type incompatível.
422	JSON bem formado com dados de domínio inválidos.
429	Quota excedida. Respeitar Retry-After.
500	Falha interna. Use requestId para diagnóstico.
503	Dependência indisponível; resultado da mutação pode ser incerto.

Exemplo 401

{
  "error": {
    "code": "unauthenticated",
    "message": "Credencial inválida, expirada ou revogada.",
    "requestId": "req_00000000000040008000000000000001",
    "documentationUrl": "https://docs.agilink.io/api/errors/#unauthenticated"
  }
}

Exemplo 403

{
  "error": {
    "code": "insufficient_permission",
    "message": "Operação sem permissão ou capacidade desabilitada.",
    "requestId": "req_00000000000040008000000000000001",
    "documentationUrl": "https://docs.agilink.io/api/errors/#insufficient-permission"
  }
}

Exemplo 409

{
  "error": {
    "code": "idempotency_conflict",
    "message": "Conflito de identidade/idempotência; operação em andamento ou segredo já exibido.",
    "requestId": "req_00000000000040008000000000000001",
    "documentationUrl": "https://docs.agilink.io/api/errors/#idempotency-conflict"
  }
}

Exemplo 429

{
  "error": {
    "code": "rate_limited",
    "message": "Quota excedida. Respeitar Retry-After.",
    "requestId": "req_00000000000040008000000000000001",
    "documentationUrl": "https://docs.agilink.io/api/errors/#rate-limited"
  }
}

Schema completo e próximos passos

Schema de request

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "at": {
      "$ref": "#/components/schemas/AnalyticsInstant"
    },
    "country": {
      "type": "string",
      "pattern": "^[A-Z]{2}$"
    },
    "platform": {
      "enum": [
        "desktop",
        "android",
        "ios"
      ]
    },
    "source": {
      "enum": [
        "browser",
        "social"
      ]
    }
  },
  "required": [
    "platform"
  ]
}

Schema de response

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "$ref": "#/components/schemas/LinkPreviewResult"
    },
    "meta": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "requestId": {
          "$ref": "#/components/schemas/RequestId"
        }
      },
      "required": [
        "requestId"
      ]
    }
  },
  "required": [
    "data",
    "meta"
  ]
}

Convenções e limites · Erros · Receitas completas · Guia funcional.