Envie uma solicitação de validação de endereço emitindo uma solicitação POST para um dos seguintes endpoints:
- validateAddress (REST)
- ValidateAddress (gRPC)
A solicitação também precisa transmitir um corpo da solicitação JSON à 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 da 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, você precisa fornecer apenas
um campo: addressLines
. No entanto, a solicitação de endereço mais simples precisa conter os seguintes subcampos:
regionCode
: recomendado. É um campo opcional, mas, se omitido, a API Address Validation infere a região do endereço. No entanto, para melhores resultados, incluaregionCode
, se souber. Consulte a lista de 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 Accuracy Support System (CASSTM) para dar suporte e certificar provedores de validação de endereço.
Somente para as regiões dos EUA e PR, é possível ativar o processamento de CASS definindo
enableUspsCass
como true
no corpo da solicitação. Para ter melhores resultados ao usar o CASS, forneça um endereço que inclua o número da rua e da rua junto com a cidade, o estado e o CEP:
{
"address": {
"regionCode": "US",
"locality": "Mountain View",
"administrativeArea": "CA",
"postalCode": "94043",
"addressLines": ["1600 Amphitheatre Pkwy"]
},
"enableUspsCass": true
}
Confira!
Com a API Explorer, você pode fazer solicitações de amostra para conhecer a API e as opções dela.
Se quiser, expanda Mostrar parâmetros padrão e defina o parâmetro
fields
como a máscara de campo.Se quiser, edite o Corpo da solicitação.
Selecione o botão Executar. Na caixa de diálogo, escolha a conta que você quer usar para fazer a solicitação.
No painel do APIs Explorer, selecione o ícone de expansão para expandir a janela dele.
-
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. ↩