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

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

Novidades

Ao criar ou atualizar um pedido de assinatura, a API agora verifica os endereços de email dos destinatários quanto a formatos potencialmente inválidos. Se algo parecer errado, receberá um aviso na resposta.

O pedido continua a ser bem-sucedido. Só recebe um aviso prévio.

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, pontos em falta e erros de digitação óbvios. Não bloqueará casos-limite legítimos, mas assinalará os que têm maior probabilidade de falhar na entrega.

Porque Isto é Importante

Os erros de digitação no email são uma das razões mais comuns pelas 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, não acontece nada e alguém abre um ticket de suporte a perguntar porque é que 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 que verifiquem novamente e evite trocas de mensagens desnecessárias.

Guia de Migração

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

Para tirar partido da funcionalidade, verifique o array warnings (ou o campo warning em PATCH) no processamento da sua resposta e apresente quaisquer mensagens aos seus utilizadores.

Comece já

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

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

preços pay-as-you-go a €0,029 por envelope, sem contratos ou mínimos.

Comece gratuitamente

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