Envoyer une requête de validation d'adresse

Envoyez une requête de validation d'adresse en envoyant une requête POST à l'un des points de terminaison suivants:

• validateAddress (REST)
• ValidateAddress (gRPC)

Votre requête doit également transmettre un corps de requête JSON à la requête qui définit l'adresse à valider. Le corps de la requête suivant contient un champ et trois sous-champs:

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"

Vous pouvez également omettre locality et le spécifier en tant qu'élément dans le tableau addressLines:

{
  "address": {
    "regionCode": "US",
    "addressLines": ["1600 Amphitheatre Pkwy", "Mountain View, CA, 94043"]
  },
}

Essayer

Champs de la demande d'adresse

Le corps de la requête ne comporte qu'un seul champ:

• address : champ de type PostalAddress, qui doit contenir au moins une entrée dans addressLines.

Lorsque vous envoyez le champ address à l'API Address Validation, vous n'avez besoin de fournir qu'un seul champ: addressLines. Toutefois, la requête d'adresse la plus simple doit contenir les sous-champs suivants:

• regionCode : recommandé. Ce champ est facultatif, mais si vous l'omettez, l'API Address Validation infère la région à partir de l'adresse. Toutefois, pour de meilleurs résultats, incluez le regionCode si vous le connaissez. Pour obtenir la liste des régions compatibles, consultez la section Régions compatibles.
• addressLines : obligatoire. Tableau d'adresses décrivant la structure inférieure de l'adresse.

Consultez PostalAddress dans le guide de référence.

Option USPS CASS™

Le service postal des États-Unis (United States Postal Service® ou USPS®)¹ gère le système CASS™ (Coding Accuracy Support System) afin d'aider et de certifier les fournisseurs de validation d'adresse.

Pour les régions des États-Unis et de Porto Rico uniquement, vous pouvez activer le traitement CASS en définissant enableUspsCass sur true dans le corps de la requête. Pour de meilleurs résultats lorsque vous utilisez le service CASS, fournissez une adresse qui comprend le nom et le numéro de la rue, ainsi que la ville, l'État et le code postal:

{
  "address": {
    "regionCode": "US",
    "locality": "Mountain View",
    "administrativeArea": "CA",
    "postalCode": "94043",
    "addressLines": ["1600 Amphitheatre Pkwy"]
  },
  "enableUspsCass": true
}

Essayer

API Explorer vous permet d'envoyer des exemples de requêtes afin de vous familiariser avec l'API et ses options.

1. Sélectionnez l'icône API  sur le côté droit de la page.

2. Vous pouvez également développer Afficher les paramètres standards et définir le paramètre fields sur le masque de champ.

3. Modifiez éventuellement le corps de la requête.

4. Sélectionnez le bouton Execute (Exécuter). Dans la boîte de dialogue, sélectionnez le compte que vous souhaitez utiliser pour effectuer la demande.

5. Dans le panneau API Explorer, sélectionnez l'icône de développement, , pour développer la fenêtre API Explorer.