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 E-mail, uma pequena adição que ajuda a detetar endereços de e-mail incorretos antes que estes causem falhas de entrega.

Novidades

Ao criar ou atualizar um pedido de assinatura, a API verifica agora os endereços de e-mail dos destinatários para identificar formatos potencialmente inválidos. Se algo parecer incorreto, receberá um aviso na resposta.

O pedido continuará a ser bem-sucedido. Apenas recebe um aviso.

Endpoints afetados:

Exemplo de resposta:

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

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

{
  "signing_request": { ... },
  "warnings": [
    "O e-mail do destinatário 'user@compny' poderá 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.

Por que motivo isto é importante

Os erros de digitação nos e-mails 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 e-mail, pode expor estes problemas aos seus utilizadores antes do envio do pedido. Mostre o aviso na sua interface, sugira que verifiquem novamente e evite as trocas de mensagens de suporte.

Guia de Migração

Sem alterações de rutura. Os avisos de validação de e-mail são puramente aditivos. Se já fez a integração com o 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 desta funcionalidade, verifique o array warnings (ou o campo warning no PATCH) no processamento da sua resposta e apresente as mensagens aos seus utilizadores.

Começar

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

Novo no Firma.dev? Pode obter a sua chave de API e começar a desenvolver em minutos. Tarifário pay-as-you-go a 0,049 € por envelope, sem contratos nem mínimos.

Comece gratuitamente

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