Guias

Como fazer White-Label de uma API de Assinatura de Documentos no seu Produto SaaS

"Substitua 'Firma.dev' pelo texto 'O Seu Logotipo'. Ícone de mão coloca o logotipo com uma seta e o aviso 'Coloque a sua marca aqui!'"

Procura a análise detalhada completa? Este artigo aborda os conceitos e decisões fundamentais. Para um passo a passo abrangente de todos os recursos de marca própria (colaborativa), incluindo logótipos, personalização de cores, modelos de e-mail personalizados, endereços de remetente e exemplos de código, consulte o The Complete Guide to White-Label E-Signatures for SaaS.

Se está a integrar uma API de assinatura de documentos no seu produto, os seus clientes não devem sentir que estão a utilizar o software de outra pessoa. A experiência de assinatura deve ter o aspeto e a sensação do seu produto, não de uma ferramenta de terceiros.

A marca própria (white-labeling) torna isso possível. Mas a maioria dos programadores pensa que a marca própria significa apenas colocar o seu logótipo em algo. Na prática, é mais subtil. Uma integração de API de assinatura digital totalmente personalizada envolve imagem de marca visual, personalização de e-mails, controlo de notificações e interfaces incorporadas, e nem sempre precisa de tudo isso. Para obter a visão completa do que pode personalizar, consulte a visão geral dos recursos da white-label e-signature API (API de assinatura eletrónica de marca própria).

Este guia detalha o que faz cada camada, quando a utilizar e como implementar uma API de assinatura de PDFs em marca própria que se adapte ao seu produto.

O que significa realmente a marca própria nas assinaturas eletrónicas

Quando um cliente assina um documento através da sua aplicação, vários pontos de contacto contêm a marca:

  • A própria interface de assinatura (logótipo, cores, layout)

  • O e-mail que os notifica de que um documento está pronto para ser assinado

  • O endereço do remetente e o modelo de e-mail

  • As notificações de conclusão e de lembrete

  • Quaisquer termos legais ou passos de aceitação

Por predefinição, a maioria das APIs de assinatura personaliza tudo isto com o seu próprio nome. A marca própria (white-labeling) permite-lhe substituir essa marca pela sua própria, ou removê-la por completo.

O objetivo é simples: os seus clientes interagem com a sua marca ao longo de todo o fluxo de trabalho de assinatura. Nunca veem o fornecedor da API subjacente.

As quatro camadas de marca própria

Camada 1: Imagem de marca visual

O impacto mais imediato. Carregue o seu logótipo, defina a sua paleta de cores e oculte completamente a marca do fornecedor da API da experiência de assinatura.

Com a Firma.dev, controla seis definições de cor (cor de destaque primária, texto do primeiro plano, fundo, cor do cartão e cor do limite) e pode carregar logótipos ao nível da empresa e do espaço de trabalho. Para produtos SaaS multitenant, isto significa que cada um dos seus clientes pode ter a sua própria identidade visual distinta no fluxo de assinatura.

Ative show_custom_branding_only e a interface de assinatura parecerá ter sido criada pela sua equipa. Sem logótipos de terceiros, sem esquemas de cores desconhecidos.

Esta camada demora minutos a implementar e tem o maior impacto visível. Comece por aqui, mesmo que planeie adicionar as outras camadas mais tarde.

Camada 2: Domínios e modelos de e-mail personalizados

Em vez de enviar pedidos de assinatura de noreply@signatureprovider.com, os e-mails vêm do seu domínio, como documents@yourcompany.com. Também controla a parte local do endereço do remetente (a parte que antecede o @), pelo que pode utilizar noreply, signing, contracts, o que melhor se adaptar ao seu produto.

Além do remetente, pode personalizar os próprios modelos de e-mail. A Firma.dev suporta modelos HTML personalizados para 11 tipos de e-mail (convites de assinatura, conclusões, lembretes, expirações e muito mais), com placeholders dinâmicos para nomes de signatários, ligações de assinatura, logótipos de empresa e detalhes de equipa. Defina modelos ao nível da empresa para garantir consistência e substitua-os por espaço de trabalho quando necessário.

Para produtos SaaS multitenant, os domínios de e-mail ao nível do espaço de trabalho significam que cada um dos seus clientes pode enviar a partir do seu próprio domínio. Uma plataforma de gestão de propriedades poderia fazer com que os e-mails de assinatura fossem enviados de leases@buildingname.com para cada propriedade.

Se procura uma implementação rápida, consulte Como personalizar os seus e-mails e ligações de assinatura eletrónica em marca própria para obter um passo a passo detalhado.

Camada 3: Controlo de notificações

E-mails com a sua marca e modelos personalizados são bons. O controlo total sobre as notificações é ainda melhor.

A maioria das APIs de assinatura digital envia e-mails automáticos para pedidos de assinatura, confirmações de conclusão, avisos de expiração e avisos de cancelamento. Uma configuração de marca própria permite-lhe desativar qualquer um ou todos estes avisos por pedido de assinatura.

Porque haveria de querer desativá-los? Porque poderá querer:

  • Enviar ligações de assinatura através da sua própria infraestrutura de e-mail

  • Integrar notificações em fluxos de comunicação já existentes com o cliente

  • Controlar o tempo dos lembretes e acompanhamentos

  • Despoletar e-mails com base na sua própria lógica de negócio

Quando desativa os e-mails da API, recupera os URLs de assinatura diretamente da API e distribui-os como pretender. Isto é especialmente útil se já tiver uma infraestrutura de e-mail transacional (SendGrid, Postmark, Customer.io) e pretender que as notificações de assinatura fluam através do mesmo sistema.

Camada 4: Experiências de assinatura incorporadas

Esta é a solução completa de marca própria. Em vez de redirecionar os utilizadores para uma página de assinatura de terceiros, incorpora a interface de assinatura diretamente na sua aplicação.

Com a assinatura incorporada, todo o fluxo de trabalho acontece dentro do seu produto. Os utilizadores nunca saem do seu domínio. Veem o seu cabeçalho, a sua navegação, o seu design. A interface de assinatura aparece como uma parte integrada da sua aplicação, renderizada com o seu logótipo e cores.

A maioria das APIs de assinatura de PDFs disponibiliza componentes incorporáveis para:

  • Assinatura: O fluxo real de assinatura do documento

  • Edição de modelos: Permitir que os utilizadores definam campos de assinatura e placeholders

  • Configuração do pedido de assinatura: Configurar destinatários, ordem e opções

As experiências incorporadas normalmente utilizam autenticação JWT (JSON Web Token). O seu back-end gera um token de curta duração e o front-end carrega o componente incorporado com esse token. Sem chaves de API expostas ao cliente.

A personalização do fluxo incorporado vai agora um passo além da própria interface. O texto do botão apresentado ao signatário é personalizável por idioma, pelo que os botões dentro da visualização de assinatura incorporada podem corresponder à terminologia do seu produto, em vez de herdarem predefinições genéricas. Consulte os rótulos de botões de assinatura personalizáveis para saber como configurá-los.

Para produtos SaaS onde a assinatura de documentos é uma funcionalidade essencial, a assinatura incorporada geralmente compensa o esforço de implementação. O seu produto parece mais coeso e mantém o controlo total sobre a experiência do utilizador.

Escolher a abordagem certa

Nem todas as integrações precisam de uma marca própria completa. Veja como decidir:

Logótipo, cores e e-mails personalizados funcionam bem quando a assinatura é uma funcionalidade secundária. Os seus clientes obtêm uma experiência profissional e personalizada sem um esforço de desenvolvimento significativo. A implementação demora algumas horas, maioritariamente configuração de DNS e um par de chamadas de API para a imagem de marca visual.

O acima estipulado + modelos de e-mail personalizados adequa-se a produtos em que deseja comunicações personalizadas sem substituir a sua infraestrutura de e-mail. Personaliza o conteúdo e o HTML dos e-mails de assinatura enquanto a Firma.dev trata do envio. Isto acrescenta uma ou duas horas de trabalho com os modelos.

O acima estipulado + controlo de notificações é o passo certo quando deseja possuir totalmente a camada de comunicação. Pode ter requisitos de conformidade específicos em torno do e-mail ou querer que as notificações de assinatura fluam através do seu sistema transacional existente. Isto acrescenta um ou dois dias de trabalho de integração.

Experiência incorporada completa é a escolha certa quando a assinatura é central para o seu produto. Plataformas de RH, ferramentas de gestão de contratos, software imobiliário, sistemas de integração de cuidados de saúde. Se os seus clientes passam muito tempo em fluxos de trabalho de assinatura, incorporar essa experiência compensa. Conte com alguns dias a uma semana de trabalho de integração, dependendo de quantos componentes incorporar.

Considerações sobre a implementação

Algumas coisas em que deve pensar antes de começar:

  1. Espaços de trabalho e multitenancy. Se está a construir um produto SaaS multitenant, procure uma API de assinatura de documentos que suporte espaços de trabalho de clientes. Cada um dos seus clientes obtém um ambiente isolado com os seus próprios modelos, histórico de assinaturas, marca e (opcionalmente) domínio de e-mail. Isto mantém os dados devidamente separados sem ter de construir isolamento de inquilinos por si próprio.

  2. A hierarquia de definições. As definições de marca na Firma.dev funcionam em cascata: o espaço de trabalho sobrepõe-se à empresa, a empresa sobrepõe-se às predefinições. Isto significa que define a marca para toda a empresa uma vez e apenas configura substituições ao nível do espaço de trabalho onde for necessário. Definir um valor de espaço de trabalho para null faz herdar do nível da empresa.

  3. Segurança. Gere tokens JWT no seu back-end, nunca no código do lado do cliente. Mantenha a expiração do token curta (1 a 4 horas é o normal). Valide as origens das mensagens em iframe se estiver a lidar com eventos de componentes incorporados.

  4. Conformidade. A marca própria não altera a validade legal das assinaturas. Uma API de assinatura digital bem concebida mantém a conformidade com o ESIGN, UETA e eIDAS, independentemente da imagem de marca. Certifique-se de que o seu fornecedor suporta os enquadramentos regulamentares relevantes para os seus clientes.

  5. Custo. As plataformas de assinatura corporativas cobram frequentemente taxas elevadas por recursos de marca própria. Alguns fornecedores incluem marca própria em todos os escalões de preços. A Firma.dev inclui todas as capacidades de marca própria com tarifas de pagamento pelo que usa a 0,029 € por envelope (~3 centavos de dólar), sem contratos ou mínimos.

Como começar

Se está a avaliar APIs de assinatura de documentos para uma integração com marca própria, comece por mapear quais os pontos de contacto que mais importam para os seus clientes. Importam-se com a marca dos e-mails? Precisam do fluxo de assinatura incorporado? As respostas orientarão o âmbito da sua implementação. Para obter uma perspetiva estratégica mais ampla em configurações de marca única e multitenant, consulte o guia completo de assinaturas eletrónicas em marca própria para SaaS.

Para um passo a passo técnico detalhado, o Firma.dev White Labeling Guide aborda domínios de e-mail personalizados, definições de notificação e componentes incorporados com exemplos de código.

Pronto para construir? Obtenha a sua chave de API e comece a integrar em horas, não em semanas.

  1. Cabeçalho

Imagem de Fundo

Pronto para adicionar assinaturas eletrónicas à sua aplicação?

Comece gratuitamente. Não é necessário cartão de crédito. Pague apenas €0,029 por envelope quando estiver pronto para começar ao vivo.

Imagem de Fundo

Pronto para adicionar assinaturas eletrónicas à sua aplicação?

Comece gratuitamente. Não é necessário cartão de crédito. Pague apenas €0,029 por envelope quando estiver pronto para começar ao vivo.

Imagem de Fundo

Pronto para adicionar assinaturas eletrónicas à sua aplicação?

Comece gratuitamente. Não é necessário cartão de crédito. Pague apenas €0,029 por envelope quando estiver pronto para começar ao vivo.