Partager via

API De plateforme numérique - Service de code postal

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, qui sont inscrits auprès de Xandr à des fins de ciblage géographique lors de la configuration d’un ou pour 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 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 :

  • Create un cache et le remplir avec un GET appel pour tous les objets du service.
  • Ensuite, pour les appels suivants GET , 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.appnexus.com/postal-code Afficher tous les codes postaux à l’aide de la pagination.
GET - https://api.appnexus.com/postal-code?min_last_modified=LAST_MODIFIED
- https://api.appnexus.com/postal-code?max_last_modified=LAST_MODIFIED		 Afficher tous les codes postaux depuis la dernière modification.
GET https://api.appnexus.com/postal-code?country_code=COUNTRY_CODE Afficher les codes postaux dans un pays spécifique.
GET https://api.appnexus.com/postal-code/meta Découvrez les champs que vous pouvez filtrer et trier.

Champs JSON

Champ Type (Longueur) Description
id int ID du code postal.
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_id string ID du pays.
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_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.
last_modified Timestamp Date et heure de la dernière modification du code postal.
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.

Remarque :
Les codes postaux peuvent parfois devenir actifs ou inactifs en fonction des modifications apportées à l’adressage IP ou des technologies de géolocalisation, ainsi que des modifications apportées aux frontières géographiques.

Exemples

Afficher tous les codes postaux

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

Afficher tous les codes postaux depuis la dernière modification

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

Afficher tous les codes postaux au Canada

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

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