مستندات فنی «استعلام کد پستی همراه با مختصات جغرافیایی»

اندپوینت و دسترسی استعلام کد پستی همراه با مختصات جغرافیایی

این صفحه مستندات فنی فراخوانی GET /ecity/v2/clients/{clientId}/postalCodeInquiryCoordinates است.

Scope: ecity:postal-code-inquiry-coordinates:get

Grant type: client_credentials

دسته‌بندی OpenAPI: کد پستی. شناسه عملیات: ecityPostalCodeInquiryCoordinatesGet.

معرفی استعلام کد پستی همراه با مختصات جغرافیایی

سرویس «استعلام کد پستی همراه با مختصات جغرافیایی» در دسته استعلام کد پستی و رهگیری مرسوله. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، راهنمای شروع را ببینید.

ورودی و خروجی استعلام کد پستی همراه با مختصات جغرافیایی

ورودی‌های اصلی: شناسه کلاینت، کدپستی.

پارامترهای اختیاری متداول: کد پیگیری.

فیلدهای مهم پاسخ: کدپستی، نام شهر/روستا، استان، شهر یا روستا، محله، شهر، آدرس، خیابان.

جزئیات نوع داده، الزامی بودن و نمونه JSON در مشخصات Elements همین صفحه آمده است.

کاربرد فنی استعلام کد پستی همراه با مختصات جغرافیایی

سرویس «استعلام کد پستی همراه با مختصات جغرافیایی» در دسته استعلام کد پستی و رهگیری مرسوله. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، راهنمای شروع را ببینید.

پس از دریافت توکن مناسب (مطابق Grant type)، درخواست را به مسیر بالا بفرستید و پاسخ را بر اساس اسکیمای اعلام‌شده پردازش کنید. راهنمای گرفتن توکن در راهنمای شروع آمده است.

در صورت خطای احراز هویت یا Scope ناکافی، ابتدا اعتبار توکن و سطح دسترسی کلاینت را بررسی کنید؛ سپس پارامترهای الزامی مسیر و بدنه را با اسکیمای همین صفحه تطبیق دهید.

برای توضیح کسب‌وکاری، موارد استفاده و پیش‌نیازها به صفحه سرویس «استعلام کد پستی همراه با مختصات جغرافیایی» مراجعه کنید.

عملیات مرتبط با استعلام کد پستی همراه با مختصات جغرافیایی

• استعلام کد پستی — GET /ecity/v2/clients/{clientId}/postalCode
• استعلام کد پستی — GET /ecity/v2/clients/{clientId}/postalCode
• استعلام مرسولات پستی — GET /ecity/v2/clients/{clientId}/postalInquiry
• استعلام مرسولات پستی — GET /ecity/v2/clients/{clientId}/postalInquiry