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

Firma.dev API v1.5.0 está agora ativo. Esta versão de atualização introduz Avisos de Validação de Email, uma pequena adição que ajuda a identificar endereços de email incorretos antes que causem falhas de entrega.

Novidades

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

O pedido ainda tem sucesso. Apenas recebe um aviso.

Endpoints afetados:

Resposta de exemplo:

{
  "signing_request": { ... },
  "warnings": [
    "Recipient email 'user@compny' may have an invalid format"
  ]
}

{
  "signing_request": { ... },
  "warnings": [
    "Recipient email 'user@compny' may have an invalid format"
  ]
}

{
  "signing_request": { ... },
  "warnings": [
    "Recipient email 'user@compny' may have an invalid format"
  ]
}

A validação identifica problemas comuns como TLDs incomuns, pontos em falta e erros óbvios de digitação. Não bloqueia casos extremos legítimos, mas assinala os que têm maior probabilidade de serem devolvidos.

Porque Isto é Importante

Os erros de digitação no email são uma das razões mais comuns para que os pedidos de assinatura falhem ao alcançar os 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 questionar porque o cliente nunca o recebeu.

Com os avisos de validação de email, pode destacar estes problemas para os seus utilizadores antes de o pedido ser enviado. Mostre o aviso na sua interface, incentive-os a verificar novamente e evite idas e vindas.

Guia de Migração

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

Para tirar partido do recurso, verifique a presença do array warnings (ou o campo warning em PATCH) no manuseio das suas respostas e apresente qualquer mensagem aos seus utilizadores.

Comece

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

Novo na Firma.dev? Pode obter a sua chave API e começar a construir em minutos. Preços pay-as-you-go a €0,029 por envelope, sem contratos ou mínimos.

Comece gratuitamente

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