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