שליחת בקשה לאימות כתובת

שולחים בקשה לאימות כתובת באמצעות שליחת בקשת POST לאחת מנקודות הקצה הבאות:

• validateAddress (REST)
• ValidateAddress (gRPC)

הבקשה צריכה גם להעביר לבקשה גוף של בקשת JSON, שמגדיר את הכתובת לאימות. גוף הבקשה הבא מכיל שדה אחד ושלושה שדות משנה:

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"

אפשר גם להשמיט את השדה locality ולציין אותו כרכיב במערך addressLines:

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

רוצים לנסות?

השדות בבקשת הכתובת

גוף הבקשה מורכב משדה אחד:

• address - שדה מסוג PostalAddress, שחייב להכיל לפחות רשומה אחת ב-addressLines.

כששולחים את השדה address ל-Address Validation API, צריך לספק רק שדה אחד: addressLines. עם זאת, בקשת הכתובת הפשוטה ביותר צריכה לכלול את שדות המשנה הבאים:

• regionCode – מומלץ. זהו שדה אופציונלי, אבל אם לא צוין אותו, ה-Address Validation API מסיק את האזור מהכתובת. עם זאת, כדי לקבל את התוצאות הטובות ביותר, כדאי לכלול את השדה regionCode, אם ידוע לכם עליו. רשימת האזורים הנתמכים מפורטים במאמר אזורים נתמכים.
• addressLines – חובה. מערך עם כתובות שמתארות את המבנה התחתון של הכתובת.

אפשר לעיין בקטע PostalAddress במדריך העזר.

אפשרות USPS CASSTM

שירות הדואר בארצות הברית (USPS®)¹ אחראי למערכת התמיכה לדיוק קידוד (CASSTM) לאימות ולמתן אישור לספקים.

באזורים בארה"ב ובאזורי PR בלבד, אפשר להפעיל עיבוד CASS על ידי הגדרת הערך true בגוף הבקשה ב-enableUspsCass. על מנת לקבל את התוצאות הטובות ביותר כשמשתמשים ב-CASS, מומלץ לציין כתובת שכוללת את מספר הרחוב והרחוב, כמו העיר, המדינה והמיקוד:

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

רוצה לנסות?

תוכלו לשלוח בקשות לדוגמה כדי להכיר את ה-API ואת האפשרויות של API.

1. לוחצים על סמל ה-API בצד ימין של הדף.

2. אפשר להרחיב את האפשרות הצג פרמטרים סטנדרטיים ולהגדיר את הפרמטר fields כמסכת שדות.

3. אפשר לערוך את גוף הבקשה.

4. לוחצים על הלחצן ביצוע. בתיבת הדו-שיח, בוחרים את החשבון שבו רוצים להשתמש כדי לשלוח את הבקשה.

5. בחלונית של API Explorer לוחצים על סמל ההרחבה כדי להרחיב את החלון של API Explorer.