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

Firma.dev API v1.5.0 está agora ao vivo. Este patch release introduz Avisos de Validação de Email, uma pequena adição que o ajuda a identificar 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 agora verifica endereços de email de destinatários para potenciais formatos inválidos. Se algo parecer errado, irá receber um aviso na resposta.

O pedido ainda é bem-sucedido. Apenas recebe um alerta.

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 deteta problemas comuns como TLDs incomuns, pontos em falta e erros óbvios de digitação. Não bloqueará casos extremos legítimos, mas sinalizará aqueles que têm maior probabilidade de falhar.

Por Que Isto Importa

Os erros de digitação em emails são uma das razões mais comuns para falhas na entrega de pedidos de assinatura 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 ticket de suporte perguntando porque é que o cliente nunca o recebeu.

Com os avisos de validação de email, pode revelar estes problemas aos seus utilizadores antes de o pedido ser enviado. Exiba o aviso na sua interface de utilizador, solicite uma dupla verificação e evite o vai e vem.

Guia de Migração

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

Para tirar partido da funcionalidade, verifique a array warnings (ou campo warning no PATCH) no tratamento da sua resposta e revele quaisquer mensagens aos seus utilizadores.

Começar

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

Novo no Firma.dev? Pode obter a sua chave de API e começar a desenvolver em minutos. Preços pay-as-you-go a $0.029 por envelope, sem contratos ou mínimos.

Comece gratuitamente

Para o changelog completo, veja a documentação da API.