Envie uma solicitação POST para um dos seguintes endpoints:
- validateAddress (REST)
- ValidateAddress (gRPC)
Sua solicitação também precisa passar um corpo de solicitação JSON para a solicitação que defina o endereço a ser validado. O corpo da solicitação a seguir contém um campo e três subcampos:
curl -X POST -d '{ "address": { "regionCode": "US", "locality": "Mountain View", "addressLines": ["1600 Amphitheatre Pkwy"] } }' \ -H 'Content-Type: application/json' \ "https://addressvalidation.googleapis.com/v1:validateAddress?key=API_KEY"
Também é possível omitir locality
e especificá-lo como um elemento na matriz addressLines
:
{
"address": {
"regionCode": "US",
"addressLines": ["1600 Amphitheatre Pkwy", "Mountain View, CA, 94043"]
},
}
Campos de solicitação de endereço
O corpo da solicitação consiste em um único campo:
address
: um campo do tipoPostalAddress
, que precisa conter pelo menos uma entrada emaddressLines
.
Ao enviar o campo address
para a API Address Validation, é necessário
fornecer apenas um campo: addressLines
. No entanto, a solicitação de endereço mais simples precisa conter os seguintes subcampos:
regionCode
— Recomendado. Esse é um campo opcional, mas, se omitido, a API Address Validation vai inferir a região do endereço. No entanto, para melhores resultados, inclua oregionCode
se você souber. Para conferir a lista de regiões com suporte, consulte as regiões com suporte.addressLines
: obrigatório. Uma matriz com endereços que descrevem a estrutura inferior do endereço.
Consulte PostalAddress no guia de referência. |
Opção USPS CASSTM
O United States Postal Service® (USPS®)1 mantém o Coding Precisão Support System (CASSTM) para dar suporte e certificar os provedores de validação de endereço.
Somente para regiões dos EUA e PR, é possível ativar o processamento do CASS definindo
enableUspsCass
como true
no corpo da solicitação. Para melhores resultados ao usar o CASS, forneça um endereço que inclua a rua e o número, além da cidade, do estado e do CEP:
{
"address": {
"regionCode": "US",
"locality": "Mountain View",
"administrativeArea": "CA",
"postalCode": "94043",
"addressLines": ["1600 Amphitheatre Pkwy"]
},
"enableUspsCass": true
}
Confira!
Com o APIs Explorer, é possível fazer solicitações de amostra para se familiarizar com a API e as opções relacionadas.
Selecione o ícone da API, , no lado direito da página.
Se quiser, expanda Mostrar parâmetros padrão e defina o parâmetro
fields
como a máscara de campo.É possível editar o Corpo da solicitação.
Selecione o botão Execute. Na caixa de diálogo, escolha a conta que você quer usar para fazer a solicitação.
No painel do API Explorer, selecione o ícone de expansão para expandir a janela do API Explorer.
-
A Plataforma Google Maps é uma licenciada não exclusiva do Serviço Postal dos Estados Unidos®. As marcas registradas a seguir são do Serviço Postal dos Estados Unidos® e usadas com permissão: United States Postal Service®, CASSTM, CASS CertifiedTM. ↩