مستندات فنی «استعلام مرسولات پستی»

اندپوینت و دسترسی استعلام مرسولات پستی

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

Scope: ecity:postal-inquiry:get

Grant type: client_credentials

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

معرفی استعلام مرسولات پستی

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

ورودی و خروجی استعلام مرسولات پستی

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

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

فیلدهای مهم پاسخ: نوع ارسال، sourcePostOffice، source، نام ایستگاه مقصد، senderName، نام دریافت کننده سفته، sourcePostalCode، destinationPostalCode.

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

کاربرد فنی استعلام مرسولات پستی

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

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

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

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

عملیات مرتبط با استعلام مرسولات پستی

• استعلام کد پستی همراه با مختصات جغرافیایی — GET /ecity/v2/clients/{clientId}/postalCodeInquiryCoordinates
• استعلام کد پستی همراه با مختصات جغرافیایی — GET /ecity/v2/clients/{clientId}/postalCodeInquiryCoordinates
• استعلام کد پستی — GET /ecity/v2/clients/{clientId}/postalCode
• استعلام کد پستی — GET /ecity/v2/clients/{clientId}/postalCode