إرسال طلب تحقق من العنوان من خلال إصدار طلب 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
— يُنصح به. يعد هذا حقلاً اختياريًا، ولكن إذا تم حذفه، تستنتج واجهة برمجة تطبيقات التحقق من صحة العنوان المنطقة من العنوان. ومع ذلك، بالنسبة لأفضل ، قم بتضمينregionCode
إذا كنت تعرفها. للحصول على قائمة بالمناطق التي تتوفّر فيها هذه الميزة، يُرجى الرجوع إلى المناطق التي تتوفّر فيها الميزة.addressLines
— مطلوبة. يشير هذا المصطلح إلى صفيف يتضمّن عناوين تصف بنية العنوان.
اطّلِع على PostalAddress في الدليل المرجعي. |
خيار USPS CASSTM
تحتفظ ®USPS® (USPS®) التابعة للولايات المتحدة1 بـ نظام دعم دقة الترميز (CASSTM) للدعم والاعتماد التحقق من العنوان.
بالنسبة إلى الولايات المتحدة والولايات المتحدة الأمريكية فقط، يمكنك تفعيل معالجة CASS من خلال ضبط
من enableUspsCass
إلى true
في نص الطلب. للحصول على أفضل النتائج عند استخدام
CASS، قم بتقديم عنوان يتضمن رقم الشارع ورقم الشارع بالإضافة إلى
المدينة والولاية والرمز البريدي:
{
"address": {
"regionCode": "US",
"locality": "Mountain View",
"administrativeArea": "CA",
"postalCode": "94043",
"addressLines": ["1600 Amphitheatre Pkwy"]
},
"enableUspsCass": true
}
جرّب الآن
يتيح لك "مستكشف واجهات برمجة التطبيقات" تقديم طلبات نموذجية حتى تتمكن من الإلمام بخيارات واجهة برمجة التطبيقات وواجهة برمجة التطبيقات.
انقر على رمز واجهة برمجة التطبيقات،
، على الجانب الأيمن من الصفحة.
يمكنك اختياريًا توسيع عرض المَعلمات العادية وضبط
fields
. المَعلمة إلى الحقل كمامة.يمكنك تعديل نص الطلب اختياريًا.
انقر على الزر تنفيذ. في مربع الحوار، اختر الحساب الذي تريد استخدامها لتقديم الطلب.
في لوحة "مستكشف واجهة برمجة التطبيقات"، حدد رمز التوسيع،
، لتوسيع نافذة مستكشف واجهة برمجة التطبيقات
-
"منصة خرائط Google" هي جهة مرخَّص لها بشكل غير حصري في الولايات المتحدة. Postal Service®. العلامات التجارية التالية مملوكة من الولايات المتحدة. Postal Service® ويتم استخدامها بإذن: United States Postal Service® ، CASSTM ، CASS CertificationTM ↩