Partager via

Soumissionnaires - Service de codes postaux

Le service de code postal est un service en lecture seule. Ce service peut être utilisé pour récupérer des ID de code postal enregistrés auprès de Xandr à des fins de ciblage géographique lors de la configuration d’un élément de ligne ou de la configuration de rapports qui prennent en charge cette dimension. Le main cas d’usage du service de code postal consiste à maintenir votre base de données de codes postaux à jour avec Xandr. Pour accéder aux modifications apportées à la base de données Xandr depuis le dernier appel que vous avez effectué au service, veillez à utiliser le min_last_modified champ dans votre appel.

Avertissement

En raison du grand nombre d’appels GET que vous devrez effectuer pour obtenir une liste complète des codes postaux (suite à la pagination), nous vous recommandons ce qui suit :

  • créer un cache et le remplir avec un appel GET pour tous les objets du service
  • ensuite, pour les appels GET suivants, utilisez le filtre pour obtenir des min_last_modified mises à jour (une fois par heure ou une fois par jour, car les codes postaux sont rarement mis à jour)

Vous ne devez omettre le min_last_modified filtre que si vous interrogez ce service pour la première fois.

API REST

HTTP, méthode Endpoint Description
GET https://api.adnxs.com/postal-code Afficher tous les codes postaux
GET https://api.adnxs.com/postal-code?country_code=COUNTRY_CODE Afficher les codes postaux dans un pays spécifique
GET https://api.adnxs.com/postal-code/meta Découvrez les champs que vous pouvez filtrer et trier par

Champs JSON

Champ Type (Longueur) Description
active valeur booléenne Indique si le code postal est actif. Si truela valeur est , le code postal est actif et disponible pour le ciblage. Si falsela valeur est , il n’existe aucune donnée de géolocalisation pour le code postal et le ciblage n’est donc pas possible.
code string Le code postal peut être une chaîne alphanumérique de 14 caractères maximum et peut contenir un espace ou un trait d’union.
country_code string Code ISO Alpha-2 pour le pays auquel la ville appartient. Vous pouvez utiliser le service pays pour récupérer la liste complète des codes pays.
country_id string ID du pays.
country_name string Nom du pays auquel appartient la ville. Vous pouvez utiliser le service de pays pour récupérer la liste complète des noms de pays.
id int ID du code postal.
last_modified Timestamp Date et heure de la dernière modification du code postal.

Exemples

Afficher tous les codes postaux au Canada

$ 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"
            },
            ...
      ]
   }
}

Afficher le code postal par ID de code 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"
        }
    }
}

Afficher tous les codes postaux depuis la dernière modification

$ 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"
      },
      ...
    ]
  }
}
  • Last updated on