Criar lógica de validação

Este documento descreve um processo para criar um sistema de verificação de endereços que processe várias respostas da API Address Validation. Ele aborda como criar sua lógica para usar a resposta corretamente, investigar outros indicadores da API e quando e como pedir mais informações aos clientes.

Em geral, a resposta da API determina as seguintes maneiras como o sistema processa um endereço:

• Corrigir : o endereço é de baixa qualidade. Peça mais informações.
• Confirmar : o endereço é de alta qualidade, mas tem mudanças em relação ao endereço de entrada. Você pode pedir confirmação.
• Aceitar: o endereço é de alta qualidade. Você pode aceitar o endereço fornecido.

Finalidade de chave

Este documento ajuda você a modificar seu sistema para analisar melhor a resposta da API e determinar as próximas ações a serem realizadas com os endereços fornecidos. O pseudocódigo a seguir ilustra um fluxo possível.

if (the API response indicates significant problems in the address)
    FIX - prompt the user to fix the address
else if (the API response indicates less significant problems in the address)
    CONFIRM - confirm with the user that the address is correct
else
    ACCEPT - continue with the address returned by the API.

A lógica exata depende da sua situação. Consulte as diretrizes de implementação para mais detalhes. Você também pode usar nossa implementação de código aberto dessa lógica, que está na biblioteca de componentes estendida.

Visão geral do fluxo de trabalho

A tabela abaixo resume duas ações para seu sistema:

1. O fluxo de trabalho a ser usado com base no comportamento de correção, confirmação e aceitação.
2. Os primeiros indicadores a serem verificados na resposta. Os indicadores descritos aqui vêm da propriedade verdict e não são os únicos a serem verificados, mas fornecem um indicador inicial da qualidade do endereço. Cada tipo de comportamento corresponde a uma seção neste documento que descreve outros indicadores que você também pode precisar investigar.

Comportamento do sistema
Corrigir o endereço	A resposta do verdict indica informações importantes ausentes que precisam ser fornecidas. O endereço retornado pela API pode não ser de qualidade entregável. Fluxo de trabalho Investigue os componentes do endereço, se necessário. Peça ao cliente para corrigir problemas de endereço. Solicite a validação do endereço atualizado. Continue com o endereço. Indicadores de veredito Qualquer uma das seguintes opções se aplica: validationGranularity definido como OTHER. addressComplete é false.
Confirmar o endereço	A resposta do verdict indica um endereço entregável, mas fez mudanças na entrada original: inferindo dados que foram corrigidos ortograficamente ou dados que podem ser confirmados. Fluxo de trabalho Correções necessárias: Investigue os componentes do endereço, se necessário. Solicite a validação do endereço atualizado. Continue com o endereço. Nenhuma correção necessária: Continue com o endereço. Indicadores de veredito Todas as alternativas a seguir se aplicam: validationGranularity contém ROUTE addressComplete é true. hasInferredComponents campo é true OU hasReplacedComponents campo é true.
Aceitar o endereço	A resposta da API Address Validation indica um endereço de excelente qualidade. Fluxo de trabalho Continue com o endereço retornado. Indicadores de veredito Todas as alternativas a seguir se aplicam: validationGranularity contém PREMISE ou melhor. addressComplete é true. Nenhum componente inferido ou substituído.

Diretrizes para implementação

Ao projetar como o sistema responde aos indicadores de validação de endereço, as recomendações a seguir podem ajudar você a criar um modelo de resposta mais eficaz. No entanto, essas são apenas recomendações. Portanto, lembre-se de que a implementação precisa ser adequada ao seu modelo de negócios.

	Orientação	Detalhes
Nível de risco	Considere o nível de tolerância para sua situação ao equilibrar entre pedir correções e aceitar o endereço conforme inserido.	A API Address Validation retorna vários indicadores que podem ser incorporados ao seu nível de risco para otimizar o processo de validação. Por exemplo, se um endereço tiver um número de rua não confirmado, você ainda poderá aceitá-lo. Por outro lado, se a operação da sua empresa exigir maior precisão de endereço, você poderá pedir ao usuário. Para um exemplo que possa se enquadrar em qualquer categoria, consulte Número de rua não confirmado fora dos EUA em Aceitar endereço: exemplos.
Aceitar endereços	É uma boa prática permitir que o sistema aceite a entrada original se o cliente não responder aos comandos.	Nesses casos, o cliente pode ter inserido um endereço que não está no o sistema, como para uma nova construção.

Teste a demonstração. O restante deste documento usa vários exemplos para ajudar você a entender o processo de fluxo de correção, confirmação e aceitação descrito acima. Você pode conferir os resultados desses exemplos inserindo-os na demonstração da API Address Validation no Maps JavaScript.

Corrigir um endereço

Corrija um endereço quando os resultados indicarem claramente que ele não pode ser entregue. Em seguida, o sistema pode pedir ao cliente que forneça as informações necessárias. Depois disso, você pode emitir novamente o fluxo de trabalho para receber um endereço entregável.

Indicadores de correção

A API Address Validation fornece vários indicadores para informar se um endereço precisa ser corrigido.

1. Granularidade da validação e componentes ausentes

Esses dois indicadores fornecem a melhor indicação de um endereço problemático:

• Sempre que o validationGranularity campo for OTHER, o sistema precisará investigar os indicadores de componentes de endereço para saber mais sobre onde o erro ocorreu e como corrigi-lo.
• Sempre que o objeto address pós-processado retornar um campo missingComponentTypes, o sistema precisará verificar esse componente. Os componentes ausentes também tornam um endereço incompleto e não entregável.

2. Outros indicadores

A API Address Validation também fornece outros indicadores para ajudar a diagnosticar problemas específicos:

Componentes suspeitos	Quando o enum de nível de confirmação de um componente é UNCOMFIRMED_AND_SUSPICIOUS, é provável que o componente esteja incorreto.
Componente não resolvido	Um unresolvedToken é uma parte da entrada não reconhecida como uma parte válida de um endereço.

3. Indicadores de endereço dos EUA

Alguns campos aplicáveis apenas a endereços dos EUA fornecem um indicador útil de que o endereço não pode ser entregue e precisa ser corrigido. Para um endereço que exige correção, você verá o seguinte:

dpvConfirmation	N, D ou vazio.

Para detalhes sobre dpvConfirmation, consulte Processar endereços dos Estados Unidos.

Exemplos de correção de endereço

Confirmar um endereço

Você confirma um endereço quando o veredito indica que a API Address Validation inferiu ou fez mudanças nos componentes do endereço para produzir um endereço validado. Nesses casos, você tem um endereço entregável, mas prefere ter mais confiança de que o endereço resultante é o pretendido pelo cliente.

Para fornecer o comando correto ao cliente, sua lógica identifica os componentes sinalizados pelo serviço para determinar qual ação ou indicador a API aplicou ao componente, como inferred, replaced ou spellCorrected. Consulte AddressComponent na referência.

Observação: considere seu nível de risco ao decidir se confirma o endereço com o cliente ou o aceita como válido.

Indicadores de confirmação

A API Address Validation fornece vários indicadores para informar se um endereço precisa ser confirmado.

1. Granularidade da validação

Uma validationGranularity de ROUTE ou melhor é aceitável, mas PREMISE ou SUBPREMISE fornece um indicador mais forte de capacidade de entrega.

2. Outros indicadores

Ao decidir confirmar a entrada de endereço com o cliente, o veredito também fornece o seguinte para determinar quais componentes investigar:

Dados inferidos	Quando o hasInferredComponents campo é true, você sabe que a API preencheu informações coletadas de outros componentes de endereço.
Dados substituídos	Quando o hasReplacedComponents campo é true, a API substituiu os dados inseridos por dados que considerou válidos para o endereço.

3. Indicadores de endereço dos EUA

Alguns campos aplicáveis apenas a endereços dos EUA indicam que sua lógica precisa confirmar os detalhes com o cliente. Uma das seguintes opções se aplica:

dpvConfirmation	S Para detalhes sobre dpvConfirmation, consulte Processar endereços dos Estados Unidos.
Resposta de endereço	Contém o campo missingComponentTypes com o valor de subpremise. Observação: se o campo contiver tipos diferentes de subpremise, a ação será incluída na categoria de endereço fixo. Consulte a lista completa de tipos de endereço na documentação de geocodificação.

Exemplos de confirmação de endereço

Aceitar um endereço

Você aceita um endereço quando o veredito fornece um alto grau de confiança de que o endereço pode ser entregue e pode ser usado sem mais interação do cliente no processo downstream.

Indicadores de aceitação

A API Address Validation fornece vários indicadores para informar se um endereço precisa ser confirmado.

1. Granularidade da validação

Uma validationGranularity de PREMISE ou melhor é aceitável, mas, em alguns casos, ROUTE ainda indica um endereço entregável.

2. Outros indicadores

Um veredito para um endereço de alta qualidade também precisa fornecer o seguinte:

• Nenhum dado substituído. Nesse caso, hasReplacedComponents: FALSE.
• Nenhum componente inferido. Nesse caso, hasInferredComponents: FALSE.

3. Indicadores de endereço dos EUA

Alguns campos aplicáveis apenas a endereços dos EUA indicam um endereço de alta qualidade que pode ser entregue. Para um endereço dos EUA aceitável, você verá o seguinte:

dpvConfirmation	Y Para detalhes sobre dpvConfirmation, consulte Processar endereços dos Estados Unidos.

Exemplos de aceitação de endereço