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