Envía una solicitud de validación de dirección con 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 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"]
},
}
El Explorador de APIs te permite realizar solicitudes en vivo para que puedas familiarizarte con la API y sus opciones:
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
: Es la 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 admitidas, consulta Regiones admitidas.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™
El 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 PR, 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 ejemplo para que te familiarices con la API y sus opciones.
Selecciona el ícono de la API api en el lado derecho de la página.
De manera opcional, edita los parámetros de la solicitud.
Selecciona el botón Ejecutar. En el diálogo, elige la cuenta que deseas usar para hacer la solicitud.
En el panel del Explorador de APIs, selecciona el ícono de pantalla completa fullscreen para expandir la ventana del Explorador de APIs.
-
Google Maps Platform es licenciatario no exclusivo del United States Postal Service®. Las siguientes marcas son propiedad del United States Postal Service® y se utilizan con el permiso correspondiente: United States Postal Service®, CASS™, CASS Certified™. ↩