Visão geral da API Address Validation

Visão geral da validação de endereço

A API Address Validation é um serviço que aceita endereços. Ele identifica e valida os componentes de endereço. Ele também padroniza o endereço para envio e encontra as coordenadas de latitude/longitude mais conhecidas. Opcionalmente, para endereços nos Estados Unidos e em Porto Rico, é possível ativar o Sistema de suporte de precisão de codificação (CASSTM, na sigla em inglês).

Por que usar a API Address Validation

Com a API Address Validation, é possível melhorar a previsibilidade das entregas e reduzir as falhas de entrega, proporcionando uma experiência aprimorada ao cliente. Para fazer isso, identifique endereços incorretos e saiba mais sobre as características deles.

Se você não precisa validar os componentes de endereço individuais para sua solicitação, a API Geocoding pode ser a melhor opção para suas necessidades. A API Geocoding converte endereços em coordenadas de latitude/longitude, enquanto a API Address Validation valida a precisão dos endereços. Para saber mais detalhes, consulte Como a API Address Validation funciona abaixo e a Visão geral da API Geocoding.

O que você pode fazer com a API Address Validation

Com a API Address Validation, é possível determinar se um endereço se refere a um lugar real. Se o endereço não se referir a um lugar real, a API poderá identificar componentes possivelmente errados que você pode apresentar aos seus clientes para corrigir. Veja um exemplo de fluxo de trabalho usando a API:

  1. O cliente insere um endereço: a imagem a seguir mostra um formulário simples que permite ao cliente inserir um endereço, possivelmente como parte de um processo de finalização da compra.
    O endereço inserido pelo cliente.

  2. O app envia o endereço para a API: o aplicativo passa esse endereço como a entrada para a API Address Validation.

  3. A API valida e padroniza o endereço: na resposta, a API Address Validation retorna o endereço completo conforme determinado pela API ou indica onde há informações.

  4. O cliente corrige ou confirma o endereço recomendado: dependendo do que a API retorna, você pode mostrar as seguintes instruções ao cliente:

    • Apresente um endereço recomendado para o cliente confirmar:
      Peça para o cliente confirmar o endereço conforme determinado pela API.

    • Instruir o cliente a adicionar informações ausentes:
      Solicitar que o cliente insira informações de endereço ausentes.

    • Solicite que o usuário corrija o endereço se a API não puder validar o endereço de entrada devido a informações ausentes ou incorretas:
      Peça para o cliente corrigir as informações de endereço.

Como a API Address Validation funciona

A validação de endereço aceita uma solicitação POST com o endereço na forma de um corpo JSON. Ele separa o endereço nos componentes individuais e, em seguida, faz as seguintes verificações e correções:

  • Correto: fornece verificações de validação no nível do componente, incluindo sublocais, quando disponível.
  • Concluído: tenta inferir componentes de endereço ausentes ou incorretos.
  • Bem formatado: limpa e padroniza o formato dos componentes do endereço.

Experimente a demonstração para ver a API Address Validation em ação.

Recursos

A tabela a seguir resume os recursos disponíveis por meio da API Address Validation e os dados retornados por ela. Para detalhes específicos, consulte a referência da API Address Validation.

Recursos de dados Dados retornados

Use os componentes no formato JSON.

Consulte Validar um endereço.

Endereço completo e validado (se possível).

Status de validação de cada componente do endereço.

Quando disponível para um endereço:

  • Geocodificação
  • Precisão de endereço
  • Dados de serviços postais, quando disponíveis.

Consulte Compreender a resposta de validação.

Como usar a API Address Validation

1 Experimente a demonstração Explore a demonstração com várias formas de endereço, corretas e incorretas. A demonstração é útil para analisar os valores de retorno do serviço e a resposta da API formatada em JSON.
2 Conferir a cobertura Consulte os detalhes de cobertura para ver quais países e regiões são compatíveis com a API Address Validation.
3 Configuração Comece em Configurar seu projeto do Google Cloud e siga as instruções a seguir.
4 Solicitar uma validação de endereço Comece com um endereço simples e, para aumentar a precisão, ative o CASS (somente para endereços nos EUA e PR). Consulte Solicitar uma validação de endereço.
5 Processar uma resposta A resposta da API Address Validation fornece duas propriedades, cada uma usada de maneiras diferentes. Consulte Compreender uma resposta básica.
6 Melhorar a precisão da validação Ajude a melhorar a precisão do endereço enviando feedback sobre as respostas da API Address Validation. Consulte Enviar feedback de validação de endereço.

Bibliotecas de clientes disponíveis

Para ver uma lista das bibliotecas de cliente disponíveis para a API Address Validation, consulte Bibliotecas de cliente.

Sobre o CASSTM

O United States Postal Service® (USPS®)1 mantém o Coding Accuracy Support System (CASSTM) para oferecer suporte e certificar provedores de validação de endereço. Um serviço CASS CertifiedTM, como a API Address Validation, foi confirmado por sua capacidade de preencher informações ausentes em um endereço, padronizá-las e atualizá-las para fornecer o endereço mais atual e preciso.

O CASS não é ativado por padrão e é compatível apenas com as regiões "US" e "PR". Para ativar CASS, defina enableUspsCass como true como parte de uma solicitação de validação. Saiba mais em Validar um endereço.

Como parte do nosso uso dos serviços do USPS, ele avalia as solicitações de endereços criados artificialmente. Se o USPS identificar que um endereço de entrada foi criado artificialmente, o Google precisará interromper a validação dos endereços do cliente e informar os dados de contato do cliente (nome e endereço), o endereço de entrada relevante e os dados de uso agregados ao USPS. Ao usar a API, você concorda com estes Termos específicos de serviço.

A seguir


  1. A Plataforma Google Maps é uma Licenciada não exclusiva do United States Postal Service®. As seguintes marcas registradas são de propriedade do United States Postal Service® e usadas com permissão: United States Postal Service®, CASSTM, CASS CertifiedTM.