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

מפתחים באזור הכלכלי האירופי (EEA)

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

בנוסף, הבקשה צריכה להעביר גוף בקשה ב-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 – שדה חובה. מערך עם כתובות שמתארות את המבנה הנמוך יותר של הכתובת.
מידע נוסף על PostalAddress במדריך העזר

אפשרות USPS CASS™‎

שירות הדואר של ארצות הברית (USPS®‎)1 מפעיל את מערכת התמיכה בדיוק הקידוד (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, לוחצים על סמל המסך המלא מסך מלא כדי להרחיב את החלון של APIs Explorer.


  1. הפלטפורמה של מפות Google היא בעלת רישיון לא בלעדי של שירות הדואר של ארה"ב (USPS®‎). הסימנים המסחריים הבאים הם בבעלות שירות הדואר של ארה"ב (USPS®‎) ונעשה בהם שימוש באישורו: United States Postal Service®‎,‏ CASS™‎, ‏ CASS Certified™‎.