Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
El Servicio de códigos postales es un servicio de solo lectura. Este servicio se puede usar para recuperar identificadores de códigos postales registrados en Xandr con fines de orientación geográfica al configurar un informe que admita esa dimensión. El principal caso de uso del servicio de códigos postales es mantener su base de datos de códigos postales actualizada con la de Xandr. Para acceder a los cambios realizados en la base de datos desde la última llamada que realizó al servicio, asegúrese de usar el campo en la min_last_modified llamada.
Advertencia
Debido a la gran cantidad de GET llamadas que necesitaría realizar para obtener una lista completa de códigos postales (como resultado de la paginación), le recomendamos lo siguiente:
- Cree una caché y rellénela con una
GETllamada para todos los objetos del servicio. - Después, para las llamadas posteriores
GET, use el filtro para obtener actualizaciones (una vez por hora o una vez al día, ya que losmin_last_modifiedcódigos postales se actualizan con poca frecuencia).
Solo debe omitir el min_last_modified filtro si está consultando este servicio por primera vez.
API de REST
| Método HTTP | Endpoint | Description |
|---|---|---|
GET |
https://api.appnexus.com/postal-code | Ver todos los códigos postales usando paginación. |
GET |
- https://api.appnexus.com/postal-code?min_last_modified=LAST_MODIFIED - https://api.appnexus.com/postal-code?max_last_modified=LAST_MODIFIED |
Ver todos los códigos postales desde la última modificación. |
GET |
https://api.appnexus.com/postal-code?country_code=COUNTRY_CODE | Ver los códigos postales de un país o región determinado. |
GET |
https://api.appnexus.com/postal-code/meta | Obtenga información sobre los campos por los que puede filtrar y ordenar. |
Campos JSON
| Campo | Tipo (longitud) | Descripción |
|---|---|---|
id |
Entero | El identificador del código postal. |
code |
string | El código postal puede ser una cadena alfanumérica de hasta 14 caracteres y puede contener un espacio o guión. |
country_id |
string | El identificador del país o región. |
country_code |
string | El código ISO Alpha-2 del país o región al que pertenece la ciudad. Puedes usar el servicio de país o región para recuperar una lista completa de los códigos de país. |
country_name |
string | El nombre del país o región al que pertenece la ciudad. Puede usar el servicio de país o región para recuperar una lista completa de los nombres de países o regiones. |
last_modified |
marca de tiempo | La fecha y hora en que se modificó por última vez el código postal. |
active |
Booleano | Designa si el código postal está activo. Si true, el código postal está activo y disponible para la segmentación. Si false, no hay datos de ubicación geográfica para el código postal, por lo que no es posible realizar la segmentación.Nota: En ocasiones, los códigos postales pueden activarse o inactivarse en función de cambios en el direccionamiento IP o cambios en las tecnologías de geolocalización, así como cambios en las fronteras geográficas. |
Ejemplos
Ver todos los códigos postales
$ curl -b cookies -c cookies -X GET 'https://api.appnexus.com/postal-code'
{
"response": {
"status": "OK",
"count": 238899,
"start_element": 0,
"num_elements": 100,
"postal_codes": [
{
"id": 120560,
"code": "AD100",
"country_id": "4",
"country_code": "AD",
"country_name": "Andorra"
},
{
"id": 120561,
"code": "AD200",
"country_id": "4",
"country_code": "AD",
"country_name": "Andorra"
},
{
"id": 120562,
"code": "AD300",
"country_id": "4",
"country_code": "AD",
"country_name": "Andorra"
},
{
"id": 120563,
"code": "AD400",
"country_id": "4",
"country_code": "AD",
"country_name": "Andorra"
},
{
"id": 120564,
"code": "AD500",
"country_id": "4",
"country_code": "AD",
"country_name": "Andorra"
},
{
"id": 120565,
"code": "AD600",
"country_id": "4",
"country_code": "AD",
"country_name": "Andorra"
},
{
"id": 120566,
"code": "AD700",
"country_id": "4",
"country_code": "AD",
"country_name": "Andorra"
},
{
"id": 173241,
"code": "1701",
"country_id": "6",
"country_code": "AF",
"country_name": "Afghanistan"
},
{
"id": 173242,
"code": "3001",
"country_id": "6",
"country_code": "AF",
"country_name": "Afghanistan"
},
...
]
}
}
Ver todos los códigos postales desde la última modificación
$ curl -b cookies -c cookies -X GET 'https://api.appnexus.com/postal-code?min_last_modified=2016-05-18+15:29:37'
{
"response": {
"status": "OK",
"count": 247890,
"start_element": 0,
"num_elements": 100,
"postal_codes": [
{
"id": 1,
"code": "00010",
"active": true,
"country_id": "113",
"country_code": "IT",
"country_name": "Italy",
"last_modified": "2015-09-15 14:40:30"
},
{
"id": 2,
"code": "00011",
"active": true,
"country_id": "113",
"country_code": "IT",
"country_name": "Italy",
"last_modified": "2015-09-15 14:40:32"
},
{
"id": 3,
"code": "00012",
"active": true,
"country_id": "113",
"country_code": "IT",
"country_name": "Italy",
"last_modified": "2015-09-15 17:29:04"
},
{
"id": 4,
"code": "00013",
"active": true,
"country_id": "113",
"country_code": "IT",
"country_name": "Italy",
"last_modified": "2015-09-15 17:29:04"
},
{
"id": 5,
"code": "00015",
"active": true,
"country_id": "113",
"country_code": "IT",
"country_name": "Italy",
"last_modified": "2015-09-15 17:29:05"
},
{
"id": 6,
"code": "00017",
"active": true,
"country_id": "113",
"country_code": "IT",
"country_name": "Italy",
"last_modified": "2015-09-15 17:29:05"
},
{
"id": 7,
"code": "00018",
"active": true,
"country_id": "113",
"country_code": "IT",
"country_name": "Italy",
"last_modified": "2015-09-15 17:29:05"
},
...
]
}
}
Ver todos los códigos postales en Canadá
$ curl -b cookies -c cookies -X GET 'https://api.appnexus.com/postal-code?country_code=CA'
{
"response": {
"status": "OK",
"count": 44101,
"start_element": 0,
"num_elements": 100,
"postal_codes": [
{
"id": 119892,
"code": "A09 0A1",
"country_id": "41",
"country_code": "CA",
"country_name": "Canada"
},
{
"id": 119893,
"code": "A0A 0B3",
"country_id": "41",
"country_code": "CA",
"country_name": "Canada"
},
{
"id": 119894,
"code": "A0A 0C3",
"country_id": "41",
"country_code": "CA",
"country_name": "Canada"
},
{
"id": 119895,
"code": "A0A 1B0",
"country_id": "41",
"country_code": "CA",
"country_name": "Canada"
},
{
"id": 119896,
"code": "A0A 1C0",
"country_id": "41",
"country_code": "CA",
"country_name": "Canada"
},
{
"id": 119897,
"code": "A0A 1E0",
"country_id": "41",
"country_code": "CA",
"country_name": "Canada"
},
...
],
}
}
Ver código postal por id. de código postal
$ curl -b cookies -c cookies 'https://api.appnexus.com/postal-code?id=10'
{
"response": {
"status": "OK",
"count": 1,
"start_element": 0,
"num_elements": 100,
"postal_code": {
"id": 10,
"code": "00021",
"country_id": "113",
"country_code": "IT",
"country_name": "Italy",
"last_modified": "2015-09-15 17:29:05"
}
}
}