إرسال طلب التحقق من العنوان

يمكنك إرسال طلب للتحقق من العنوان من خلال إصدار طلب 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 إلى واجهة برمجة تطبيقات التحقق من صحة العنوان، ستحتاج إلى توفير حقل واحد فقط: addressLines. ومع ذلك، يجب أن يحتوي أبسط طلب عنوان على الحقول الفرعية التالية:

• regionCode — يُنصح به. هذا الحقل اختياري، ولكن في حال حذفه، تستنتج واجهة برمجة التطبيقات Address Validation API المنطقة من العنوان. ومع ذلك، للحصول على أفضل النتائج، أدرِج regionCode إذا كان لديك. للحصول على قائمة المناطق التي تتوفّر فيها الخدمة، يُرجى الاطّلاع على المناطق التي تتوفّر فيها الخدمة.
• addressLines — مطلوبة. صفيف يحتوي على عناوين تصف البنية الأدنى للعنوان

خيار USPS CASS™

تحتفظ ®USPS® (USPS®)¹ بنظام دعم دقة الترميز (CASSTM) لدعم موفّري خدمات التحقّق من العنوان واعتمادهم.

في منطقتَي الولايات المتحدة والمقاطعة البرتغالية فقط، يمكنك تفعيل معالجة CASS من خلال ضبط قيمة enableUspsCass على true في نص الطلب. للحصول على أفضل النتائج عند استخدام CASS، قدِّم عنوانًا يتضمّن الشارع ورقم الشارع بالإضافة إلى المدينة والولاية والرمز البريدي:

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

جرّب الآن

يتيح لك مستكشف واجهات برمجة التطبيقات تقديم طلبات نموذجية حتى تتعرّف على خيارات واجهة برمجة التطبيقات وواجهة برمجة التطبيقات.

1. انقر على رمز واجهة برمجة التطبيقات على يسار الصفحة.

2. يمكنك اختياريًا توسيع عرض المَعلمات العادية وضبط مَعلمة fields على قناع الحقل.

3. يمكنك اختياريًا تعديل نص الطلب.

4. انقر على الزر تنفيذ. في مربّع الحوار، اختَر الحساب الذي تريد استخدامه لتقديم الطلب.

5. في لوحة "مستكشف واجهات برمجة التطبيقات"، انقر على رمز التوسيع، ، لتوسيع نافذة "مستكشف واجهات برمجة التطبيقات".