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

כדי לשלוח בקשה לאימות כתובת, שולחים בקשת 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"]
  },
}

ב-APIs Explorer אפשר לשלוח בקשות בזמן אמת כדי להתנסות ב-API ובאפשרויות שלו:

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

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

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

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

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

האפשרות USPS CASS™

שירות הדואר של ארצות הברית (USPS)‏¹ מנהל את מערכת התמיכה בתקינות קידוד (CASS™) כדי לתמוך בספקי אימות כתובות ולאשר אותם.

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

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

נסה בעצמך!

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

1. בוחרים בסמל ה-API api בצד שמאל של הדף.

2. אפשר לערוך את פרמטרים הבקשה.

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

4. בחלונית של APIs Explorer, בוחרים בסמל המסך המלא fullscreen כדי להרחיב את החלון של APIs Explorer.