Compartir a través de

Licitadores: servicio de código postal

  • Artículo

El servicio de código postal es un servicio de solo lectura. Este servicio se puede usar para recuperar identificadores de código postal registrados con Xandr con fines de destino de geografía al configurar un elemento de línea o para configurar informes que admitan esa dimensión. El caso de uso principal del Servicio de código postal es mantener la base de datos de código postal actualizada con la de Xandr. Para acceder a los cambios realizados en la base de datos Xandr desde la última llamada que realizó al servicio, asegúrese de usar el campo en la min_last_modified llamada.

Advertencia

Debido al gran número de llamadas GET que tendría que realizar para obtener una lista completa de códigos postales (como resultado de la paginación), se recomienda lo siguiente:

  • crear una memoria caché y rellenarla con una llamada GET para todos los objetos del servicio
  • a continuación, para las llamadas GET posteriores, use el min_last_modified filtro para obtener actualizaciones (una vez por hora o una vez al día, ya que los códigos postales se actualizan con poca frecuencia)

Solo debe omitir el min_last_modified filtro si consulta este servicio por primera vez.

API de REST

Http (método) Endpoint Description
GET https://api.adnxs.com/postal-code Ver todos los códigos postales
GET https://api.adnxs.com/postal-code?country_code=COUNTRY_CODE Visualización de códigos postales en un país específico
GET https://api.adnxs.com/postal-code/meta Averigüe por qué campos puede filtrar y ordenar

Campos JSON

Campo Tipo (longitud) Description
active booleano Designa si el código postal está activo. Si truees , el código postal está activo y disponible para la selección de destino. Si falsees , no hay datos de ubicación geográfica para el código postal, por lo que no es posible establecer como destino.
code string El código postal puede ser una cadena alfanumérica de hasta 14 caracteres y puede contener un espacio o un guion.
country_code string Código ISO Alfa-2 para el país al que pertenece la ciudad. Puede usar country service para recuperar una lista completa de códigos de país.
country_id string El identificador del país.
country_name string Nombre del país al que pertenece la ciudad. Puede usar country service para recuperar una lista completa de nombres de país.
id Entero Identificador del código postal.
last_modified Timestamp Fecha y hora en que se modificó por última vez el código postal.

Ejemplos

Ver todos los códigos postales en Canadá

$ curl -b cookies -c cookies -X GET  'https://api.adnxs.com/postal-code?country_code=CA'
{
        "response": {
        "status": "OK",
        "count": 44101,
        "start_element": null,
        "num_elements": null,
        "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"
            },
            ...
      ]
   }
}

Ver el código postal por id. de código postal

$ curl -b cookies -c cookies  'https://api.adnxs.com/postal-code?id=10'
      
{
    "response": {
        "status": "OK",
        "count": 1,
        "start_element": null,
        "num_elements": null,
        "postal_code": {
            "id": 10,
            "code": "00021",
            "country_id": "113",
            "country_code": "IT",
            "country_name": "Italy"
        }
    }
}

Ver todos los códigos postales desde la última modificación

$ curl -b cookies -c cookies -X GET  'https://api.adnxs.com/postal-code?min_last_modified=2017-06-28+15:02:37
{
    "response": {
        "status": "OK",
        "count": 8735,
        "start_element": null,
        "num_elements": null,
        "postal_codes": [{
            "id": 322567,
            "code": "2645-018",
            "active": true,
            "country_id": "186",
            "country_code": "PT",
            "country_name": "Portugal",
            "last_modified": "2017-06-26 15:39:18"
         },
         {
            "id": 322568,
            "code": "BS5 7XA",
            "active": true,
            "country_id": "80",
            "country_code": "GB",
            "country_name": "United Kingdom",
            "last_modified": "2017-06-26 15:39:18"
         },
         {
            "id": 322569,
            "code": "DE7 8HB",
            "active": true,
            "country_id": "80",
            "country_code": "GB",
            "country_name": "United Kingdom",
            "last_modified": "2017-06-26 15:39:18"
      },
      ...
    ]
  }
}