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

שולחים בקשה לאימות כתובת על ידי שליחת בקשת 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®)¹ שומר על מערכת התמיכה בנושא דיוק הקידוד (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.

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

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

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

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

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