Firma.dev API v1.5.0: Avisos de Validação de Email

A API do Firma.dev v1.5.0 já está disponível. Esta versão de correção introduz os Avisos de Validação de Email, uma pequena adição que o ajuda a detetar endereços de email incorretos antes que causem falhas na entrega.

O Que Há de Novo

Quando cria ou atualiza um pedido de assinatura, a API verifica agora os endereços de email dos destinatários para identificar formatos potencialmente inválidos. Se algo parecer incorreto, receberá um aviso na resposta.

O pedido continua a ser bem-sucedido. Apenas recebe um aviso preventivo.

Endpoints afetados:

Exemplo de resposta:

{
  "signing_request": { ... },
  "warnings": [
    "O email do destinatário 'user@compny' pode ter um formato inválido"
  ]
}

{
  "signing_request": { ... },
  "warnings": [
    "O email do destinatário 'user@compny' pode ter um formato inválido"
  ]
}

{
  "signing_request": { ... },
  "warnings": [
    "O email do destinatário 'user@compny' pode ter um formato inválido"
  ]
}

A validação deteta problemas comuns, como TLDs invulgares, falta de pontos e erros de digitação óbvios. Não bloqueará casos limite legítimos, mas sinalizará aqueles que têm maior probabilidade de ser devolvidos.

Porque É que Isto É Importante

Os erros de digitação nos emails são um dos motivos mais comuns pelos quais os pedidos de assinatura não chegam aos destinatários. Uma letra em falta, um domínio trocado, um erro de copiar e colar. O documento é enviado, nada acontece e alguém abre um pedido de suporte a perguntar por que razão o seu cliente nunca o recebeu.

Com os avisos de validação de email, pode apresentar estes problemas aos seus utilizadores antes de o pedido ser enviado. Mostre o aviso na sua interface, peça-lhes para confirmarem e evite as trocas de mensagens de suporte.

Guia de Migração

Sem alterações estruturais. Os avisos de validação de email são puramente adicionais. Se já está integrado com o Firma.dev, o seu código continuará a funcionar exatamente como antes. O campo warnings simplesmente aparece nas respostas quando aplicável.

To take advantage of the feature, check for the warnings array (or warning field on PATCH) in your response handling and surface any messages to your users.

Começar

Se já utiliza o Firma.dev, está tudo pronto. A funcionalidade está ativa em todos os endpoints de pedidos de assinatura.

Novo no Firma.dev? Pode obter a sua chave de API e começar a programar em minutos. Preços flexíveis a €0,049 por envelope, sem contratos ou mínimos.

Comece gratuitamente

Para consultar o registo de alterações completo, consulte a documentação da API.