שולחים בקשה לאימות כתובת באמצעות שליחת בקשת 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®)1 אחראי למערכת התמיכה לדיוק קידוד (CASSTM) לאימות ולמתן אישור לספקים.
באזורים בארה"ב ובאזורי PR בלבד, אפשר להפעיל עיבוד CASS על ידי הגדרת הערך true
בגוף הבקשה ב-enableUspsCass
. על מנת לקבל את התוצאות הטובות ביותר כשמשתמשים ב-CASS, מומלץ לציין כתובת שכוללת את מספר הרחוב והרחוב, כמו העיר, המדינה והמיקוד:
{
"address": {
"regionCode": "US",
"locality": "Mountain View",
"administrativeArea": "CA",
"postalCode": "94043",
"addressLines": ["1600 Amphitheatre Pkwy"]
},
"enableUspsCass": true
}
רוצה לנסות?
תוכלו לשלוח בקשות לדוגמה כדי להכיר את ה-API ואת האפשרויות של API.
לוחצים על סמל ה-API בצד ימין של הדף.
אפשר להרחיב את האפשרות הצג פרמטרים סטנדרטיים ולהגדיר את הפרמטר
fields
כמסכת שדות.אפשר לערוך את גוף הבקשה.
לוחצים על הלחצן ביצוע. בתיבת הדו-שיח, בוחרים את החשבון שבו רוצים להשתמש כדי לשלוח את הבקשה.
בחלונית של API Explorer לוחצים על סמל ההרחבה כדי להרחיב את החלון של API Explorer.
-
הפלטפורמה של מפות Google היא בעל רישיון לא בלעדי של שירות הדואר של ארצות הברית. הסימנים המסחריים הבאים הם בבעלות שירות הדואר של ארצות הברית, שנעשה בהם שימוש באישור: United States Postal Service® , CASSTM, CASS CertifiedTM. ↩