ঠিকানা যাচাইকরণ API একটি JSON অবজেক্ট হিসাবে একটি প্রতিক্রিয়া বডি প্রদান করে যাতে দুটি শীর্ষ-স্তরের বৈশিষ্ট্য থাকে:
-
result,ValidationResultধরণের একটি বস্তু -
responseID
{
"result": {
// Validation verdict.
"verdict": {},
// Address details determined by the API.
"address": {},
// The geocode generated for the input address.
"geocode": {},
// Information indicating if the address is a business, residence, etc.
"metadata": {},
// Information about the address from the US Postal Service
// ("US" and "PR" addresses only).
"uspsData": {},
},
// A unique identifier generated for every request to the API.
"responseId": "ID"
}
এই ডকুমেন্টটি result বস্তুর উপর আলোকপাত করে। responseID সম্পর্কে তথ্যের জন্য, আপডেট করা ঠিকানাগুলি হ্যান্ডেল করুন দেখুন।
verdict সম্পত্তি
verdict প্রোপার্টি ঠিকানা যাচাইয়ের ফলাফলের সারসংক্ষেপ করে এবং ঠিকানা যাচাইয়ের লজিক তৈরি করার সময় মূল্যায়ন করা প্রথম প্রোপার্টি হওয়া উচিত। আউটপুট অ্যাড্রেসের মানের উপর নির্ভর করে প্রোপার্টিটি বিভিন্ন ক্ষেত্র ফেরত দিতে পারে। উদাহরণস্বরূপ, নিম্নলিখিতটি ভালো মানের একটি অ্যাড্রেসের verdict প্রোপার্টি দেখায়, যা এই নির্দিষ্ট অনুরোধের জন্য 4টি ক্ষেত্র ফেরত দেয়:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "PREMISE",
"geocodeGranularity": "PREMISE",
"addressComplete": true,
"possibleNextAction": "ACCEPT"
}
নিম্নলিখিত বিভাগগুলিতে verdict সম্পত্তির সমস্ত ক্ষেত্র সংক্ষিপ্ত করা হয়েছে।
| রেফারেন্স গাইডে রায় দেখুন। |
সম্ভাব্য পরবর্তী পদক্ষেপ
possibleNextAction প্রপার্টিটি API প্রতিক্রিয়ার বাকি অংশের একটি ব্যাখ্যামূলক সারাংশ প্রদান করে, যার লক্ষ্য হল আপনার গ্রাহককে তাদের ঠিকানা পর্যালোচনা করতে বা সম্পাদনা করতে বলা উচিত কিনা তা নির্ধারণ করতে সহায়তা করা। আরও বিস্তারিত জানার জন্য Build your validation logic দেখুন।
ঠিকানার গ্রানুলারিটি
ঠিকানা গ্রানুলারিটি বলতে কোনও ঠিকানা বা জিওকোডের নির্দিষ্টতা নির্ধারণে ব্যবহৃত বিশদের স্তরকে বোঝায়। validationGranularity ঠিকানার নির্দিষ্টতা গ্রানুলারিটি প্রতিক্রিয়া একটি মূল সংকেত যা কোনও ঠিকানা সরবরাহযোগ্য কিনা তা নির্ধারণ করে।
verdict বৈশিষ্ট্য এই গ্র্যানুলারিটি সংকেতগুলি ফেরত দেয়:
-
inputGranularity— ঠিকানা যাচাইকরণ API-তে প্রেরিত ঠিকানা থেকে সংগৃহীত বিশদের স্তর বর্ণনা করে। অনুরোধে ঠিকানার বিশদের স্তর যাচাইকরণ প্রতিক্রিয়ায় ঠিকানার বিশদের স্তরকে প্রভাবিত করে। উদাহরণস্বরূপ,PREMISEস্তরের নীচেinputGranularityসহ একটি ঠিকানা সাধারণতPREMISEস্তরেvalidationGranularityফলাফল দেয় না। -
validationGranularity— ঠিকানা যাচাইকরণ API যে গ্র্যানুলারিটি স্তরে ঠিকানাটিকে সম্পূর্ণরূপে যাচাই করতে পারে। বেশিরভাগ ক্ষেত্রে,PREMISEবাSUB_PREMISEএর গ্র্যানুলারিটি স্তর এমন একটি গুণমানের ঠিকানা নির্দেশ করে যা সম্ভবত বিতরণযোগ্য। -
geocodeGranularity— ঠিকানার সাথে সম্পর্কিত জিওকোডের বিশদের স্তর বর্ণনা করে। উদাহরণস্বরূপ, গুগল রেকর্ডগুলি একটি অ্যাপার্টমেন্ট নম্বরের অস্তিত্ব নির্দেশ করতে পারে, কিন্তু একটি বৃহৎ অ্যাপার্টমেন্ট কমপ্লেক্সের মধ্যে সেই নির্দিষ্ট অ্যাপার্টমেন্টের জন্য একটি সুনির্দিষ্ট অবস্থান নির্দেশ করতে পারে না। সেক্ষেত্রে,validationGranularityহলSUB_PREMISEকিন্তুgeocodeGranularityisPREMISE`।
| রেফারেন্স গাইডে গ্রানুলারিটি দেখুন। |
ঠিকানার সম্পূর্ণতা
রায়টি addressComplete প্রপার্টিটিকে একটি উচ্চ-মানের ঠিকানার সংকেত হিসেবে ফেরত দেয়, যার অর্থ বিশেষভাবে এটিতে কোনও অনুপস্থিত, অমীমাংসিত বা অপ্রত্যাশিত উপাদান নেই:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "PREMISE",
"geocodeGranularity": "PREMISE",
"addressComplete": true,
"possibleNextAction": "ACCEPT"
}
যখন ঠিকানাটিতে অনুপস্থিত, অমীমাংসিত, অথবা অপ্রত্যাশিত উপাদান থাকে, তখন ক্ষেত্রটি false তে সেট করা হয়।
রেফারেন্স গাইডে রায় এবং ঠিকানার অধীনে addressComplete দেখুন। |
ঠিকানার মান
বেশ কিছু সম্ভাব্য ক্ষেত্র ঠিকানা উপাদানগুলির সমস্যা, অথবা তাদের সমন্বয়, যেমন অনুমান করা বা অনুপস্থিত ঠিকানা উপাদানগুলি নির্দেশ করে। উদাহরণস্বরূপ, নিম্নলিখিত verdict বৈশিষ্ট্যটি অ-নিশ্চিত উপাদানগুলির সাথে একটি ঠিকানা এবং একটি অনুপস্থিত addressComplete ক্ষেত্র নির্দেশ করে:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "OTHER",
"geocodeGranularity": "OTHER",
"hasUnconfirmedComponents": true,
"hasInferredComponents": true
}
| রেফারেন্স গাইডে রায় দেখুন। |
address এবং addressComponent বৈশিষ্ট্য
address বৈশিষ্ট্যটি অনুরোধে প্রদত্ত প্রক্রিয়াকৃত ঠিকানার জন্য ফর্ম্যাটিং প্রদান করে, ঠিকানার কম্পোনেন্ট-স্তরের সারাংশের সাথে, ঠিকানার ভুল বানানযুক্ত অংশ, প্রতিস্থাপিত ভুল অংশ এবং অনুপস্থিত অনুপস্থিত অংশগুলি সহ।
রেফারেন্স গাইডে Address দেখুন। |
addressComponent প্রপার্টি হল address একটি উপ-উপাদান যা ঠিকানার উপাদানগুলির—অথবা উপাদানগুলির—একটি বিস্তারিত তালিকা প্রদান করে যা ঠিকানা বৈধকরণ API প্রক্রিয়া করেছে। API প্রতিটি উপাদান ক্ষেত্রকে তার নাম, ধরণ এবং নিশ্চিতকরণ স্তর দ্বারা চিহ্নিত করে।
রেফারেন্স গাইডে addressComponent দেখুন। |
geocode সম্পত্তি
geocode প্রপার্টি ইনপুট ঠিকানার সাথে সম্পর্কিত জিওকোডেড অবস্থান নির্দেশ করে। এই প্রপার্টিটি অবস্থান সম্পর্কে বিস্তারিত তথ্য প্রদান করে, যেমন এর স্থান আইডি।
রেফারেন্স গাইডে Geocode দেখুন। |
metadata সম্পত্তি
ঠিকানা যাচাইকরণ API দ্বারা প্রক্রিয়াকৃত প্রতিটি ঠিকানার জন্য এই বৈশিষ্ট্যটি পূরণ নাও হতে পারে, তবে ঠিকানাটি আবাসিক, ব্যবসা, অথবা কোনও PO বক্সের ধরণের কিনা তা নির্দেশ করে।
ঠিকানা যাচাইকরণ API কভারেজ এবং Address metadata রেফারেন্স দেখুন। |
uspsData সম্পত্তি
এই সম্পত্তিটি মার্কিন যুক্তরাষ্ট্রের ডাক ঠিকানাগুলির জন্য দরকারী তথ্য প্রদান করে। তবে, পরিষেবা দ্বারা যাচাইকৃত প্রতিটি ঠিকানার জন্য এটি সম্পূর্ণরূপে পূরণ করা হবে এমন নিশ্চয়তা নেই। সেই কারণে, ঠিকানা যাচাই করার একমাত্র উপায় হিসাবে আপনার এই সম্পত্তির উপর নির্ভর করা উচিত নয়, বরং verdict এবং address পরীক্ষা করে দেখুন।
মার্কিন যুক্তরাষ্ট্রের ঠিকানাগুলি পরিচালনা করুন এবং UspsData এর রেফারেন্স দেখুন। |