Para enviar una solicitud de validación de dirección, emite una solicitud POST a uno de los siguientes extremos:
- validateAddress (REST)
- ValidateAddress (gRPC)
Tu solicitud también debe pasar un cuerpo de solicitud JSON a la solicitud que define la dirección que se debe validar. El siguiente cuerpo de la solicitud contiene un campo y tres 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"
También puedes omitir locality
y especificarlo como un elemento en el array addressLines
:
{
"address": {
"regionCode": "US",
"addressLines": ["1600 Amphitheatre Pkwy", "Mountain View, CA, 94043"]
},
}
Campos de solicitud de dirección
El cuerpo de la solicitud consta de un solo campo:
address
: Es un campo de tipoPostalAddress
que debe contener al menos una entrada enaddressLines
.
Cuando envíes el campo address
a la API de Address Validation, solo debes proporcionar un campo: addressLines
. Sin embargo, la solicitud de dirección más simple debe contener los siguientes subcampos:
regionCode
: Opción recomendada. Este es un campo opcional, pero si se omite, la API de Address Validation infiere la región a partir de la dirección. Sin embargo, para obtener mejores resultados, incluye elregionCode
si lo conoces. Para obtener la lista de regiones compatibles, consulta regiones compatibles.addressLines
: Obligatorio. Es un array con direcciones que describen la estructura inferior de la dirección.
Consulta PostalAddress en la guía de referencia. |
Opción de USPS CASS™
United States Postal Service® (USPS®)1 mantiene el Coding Accuracy Support System (CASS™) para respaldar y certificar a los proveedores de validación de direcciones.
Solo para las regiones de EE.UU. y Puerto Rico, puedes habilitar el procesamiento de CASS configurando enableUspsCass
como true
en el cuerpo de la solicitud. Para obtener los mejores resultados cuando uses CASS, proporciona una dirección que incluya la calle y el número de la calle, junto con la ciudad, el estado y el código postal:
{
"address": {
"regionCode": "US",
"locality": "Mountain View",
"administrativeArea": "CA",
"postalCode": "94043",
"addressLines": ["1600 Amphitheatre Pkwy"]
},
"enableUspsCass": true
}
Pruébalo
El Explorador de APIs te permite realizar solicitudes de muestra para que te familiarices con la API y sus opciones.
Selecciona el ícono de la API, , en el lado derecho de la página.
De manera opcional, puedes expandir Show standard parameters y establecer el parámetro
fields
en la máscara de campo.De manera opcional, edita el Cuerpo de la solicitud.
Selecciona el botón Ejecutar. En el cuadro de diálogo, elige la cuenta que quieres usar para realizar la solicitud.
En el panel del Explorador de API, selecciona el ícono de expansión, , para expandir la ventana del Explorador de API.
-
Google Maps Platform es licenciatario no exclusivo del United States Postal Service®. Las siguientes marcas son propiedad del United States Postal Service® y se usan con el permiso correspondiente: United States Postal Service®, CASSTM, CASSTM Certified. ↩