Pular para o conteúdo principal
API PDF4meIntegraçõesBase de conhecimentoExtensõesTestador de APIBlog

Hiperligações em Modelos - Guia de Links Dinâmicos

Os hiperlinks tornaram-se componentes essenciais dos documentos modernos, aparecendo em faturas, contratos, orçamentos, documentos legais, relatórios e diversas comunicações comerciais. PDF4me Permite a inserção dinâmica de hiperlinks em documentos gerados, possibilitando a criação de documentação interativa e conectada à web.

Insira hiperlinks clicáveis em seus documentos usando a seguinte sintaxe de modelo:

<<link[linkUrl][linkDisplay]>>

Componentes:

  • linkUrl - O alvo URL ou endereço web
  • linkDisplay - O texto exibido para o link clicável

Sintaxe do modelo:

Visit our website: <<link[websiteUrl][companyName]>>

Fonte de dados (JSON):

{
  "websiteUrl": "https://dev.pdf4me.com/",
  "companyName": "PDF4me API Website"
}

Resultado gerado:

Visit our website: PDF4me API Website

(Onde "PDF4me API "Website" é um link clicável para https://dev.pdf4me.com/)

Gere vários hiperlinks dentro de um documento usando diferentes campos de dados.

Exemplo: Informações de contato​

Modelo:

Website: <<link[website][websiteName]>>
Support Portal: <<link[supportUrl][supportText]>>
Documentation: <<link[docsUrl][docsText]>>

Dados:

{
  "website": "https://pdf4me.com/",
  "websiteName": "PDF4me Homepage",
  "supportUrl": "https://dev.pdf4me.com/support/",
  "supportText": "Contact Support",
  "docsUrl": "https://dev.pdf4me.com/documentation/",
  "docsText": "View Documentation"
}

Hiperligações em tabelas​

Combine hiperlinks com estruturas de tabela para apresentações de links organizadas.

Exemplo de tabela de recursos​

Modelo:

Resource | Link
<<foreach [resource in resources]>>
<<[resource.name]>> | <<link[resource.url][resource.linkText]>>
<</foreach>>

Dados:

{
  "resources": [
    {
      "name": "API Documentation",
      "url": "https://dev.pdf4me.com/documentation/",
      "linkText": "View Docs"
    },
    {
      "name": "Support Center",
      "url": "https://dev.pdf4me.com/support/",
      "linkText": "Get Help"
    },
    {
      "name": "Code Samples",
      "url": "https://github.com/pdf4me/samples",
      "linkText": "Browse Code"
    }
  ]
}

Dinâmico URL Construção​

Construir URLs dinamicamente usando expressões e concatenação.

Modelo:

<<foreach [product in products]>>
Product: <<[product.name]>>
View Details: <<link["https://example.com/product/" + product.id][product.name]>>
<</foreach>>

Modelo:

Contact: <<link["mailto:" + employee.email][employee.name]>>

Dados:

{
  "employee": {
    "name": "John Smith",
    "email": "[email protected]"
  }
}

Saída:

Contact: John Smith

(Ao clicar, o cliente de e-mail com o endereço do modelo será aberto.)

Hiperligações condicionais​

Exibir hiperlinks somente quando determinadas condições forem atendidas.

Modelo:

<<if [websiteUrl != null]>>
Visit us: <<link[websiteUrl][websiteName]>>
<</if>>

Modelo com Foreach:

<<foreach [contact in contacts]>>
<<[contact.name]>>
<<if [contact.website != null]>> - <<link[contact.website]["Visit Website"]>><</if>>
<</foreach>>

Texto de exibição formatado​

Aplicar formatação de texto ao texto de exibição do hiperlink para links estilizados.

Modelo:

Visit: <<link[url][companyName:caps]>>

Dados:

{
  "url": "https://pdf4me.com",
  "companyName": "pdf4me solutions"
}

Saída:

Visit: Pdf4me Solutions

(Com a capitalização correta e link clicável)

Casos de uso comuns​

Modelo:

Questions? Visit our FAQ: <<link[faqUrl]["FAQ Page"]>>
Payment Portal: <<link[paymentUrl]["Pay Invoice"]>>
Contact Support: <<link["mailto:" + supportEmail]["Email Support"]>>

Referências do relatório​

Modelo:

Data Sources:
<<foreach [source in dataSources]>>
- <<[source.name]>>: <<link[source.url][source.description]>>
<</foreach>>

Catálogo de Produtos​

Modelo:

<<foreach [product in products]>>
Product Name: <<[product.name]>>
Price: $<<[product.price]>>
More Info: <<link[product.detailsUrl]["View Details"]>>

<</foreach>>

URL Gerenciamento​

  1. Validar URLs - Garantir URLs são formatados corretamente antes de serem passados para os modelos.
  2. Usar HTTPS - Prefira a segurança HTTPS URLs sempre que possível
  3. Texto de exibição curto - Mantenha o texto do link conciso e descritivo.
  4. Links de teste - Verifique se todos os links gerados funcionam corretamente.
  1. Formatação consistente - Utilize padrões de texto de link semelhantes em todos os documentos.
  2. Contexto claro - Deixe claro o propósito do link a partir do texto exibido.
  3. distinção visual - Garantir que os links sejam visualmente distintos (geralmente automático)

Preparação de dados​

  1. Codificar caracteres especiais - Lidar com caracteres especiais em URLs apropriadamente
  2. Fornecer valores padrão - Ter valores alternativos para casos ausentes. URL dados
  3. Validação - Validar URL formate seu aplicativo antes do processamento do modelo
<<link["https://example.com"]["Visit Website"]>>
<<link["mailto:[email protected]"]["Email Us"]>>

Use seu próprio e-mail ou um endereço genérico; evite usar e-mails de suporte/contato diretamente nos modelos para evitar links quebrados em alguns servidores.

<<link["file:///path/to/document.pdf"]["View PDF"]>>
<<link["tel:+1234567890"]["Call Us"]>>

Solução de problemas​

Problemas comuns​

Emitir: Links não clicáveis no documento gerado
Solução: Verifique se a sintaxe corresponde exatamente: <<link[url][text]>>

Emitir: Quebrado URLs na saída
Solução: Verificar caracteres especiais; codificar URLs apropriadamente

Emitir: O texto exibido mostra a sintaxe do campo de mesclagem.
Solução: Garantir o fechamento >> Os colchetes estão presentes

Emitir: Os links são exibidos como texto simples.
Solução: Verifique se o visualizador de documentos suporta hiperlinks.

Exemplo completo: Comunicação com o cliente​

Modelo:

Dear <<[customerName]>>,

Thank you for your recent purchase. Your order details are available at:
<<link[orderTrackingUrl]["Track Your Order"]>>

For assistance, please visit:
- Help Center: <<link[helpUrl]["Get Help"]>>
- Email Support: <<link["mailto:" + supportEmail]["Contact Support"]>>
- Live Chat: <<link[chatUrl]["Start Chat"]>>

Best regards,
<<[companyName]>>

Dados:

{
  "customerName": "John Smith",
  "orderTrackingUrl": "https://example.com/track/12345",
  "helpUrl": "https://example.com/help",
  "supportEmail": "[email protected]",
  "chatUrl": "https://example.com/chat",
  "companyName": "Acme Corporation"
}

:::dica Teste de links Sempre teste os documentos gerados com hiperlinks reais para garantir que funcionem corretamente em diferentes plataformas. PDF visualizadores e plataformas. Alguns visualizadores podem lidar com certos tipos de links de maneira diferente. :::