# مستندات API

این مرجع هنگام ساخت سایت مستقیماً از OpenAPI زنده‌ی نسخه ۵ تولید می‌شود. در حال حاضر 49 وب‌سرویس در 5 دسته قرار دارد. برای مشاهده پارامترها و نمونه کد، سرویس موردنظر را از سایدبار انتخاب کنید.

# پیش از شروع

راهنما موضوع
احراز هویت دریافت و تمدید توکن Bearer
قالب پاسخ ساختار meta و data در همه سرویس‌ها
شناسه پیگیری و حالت درخواست trackId و requestHandlingType
فهرست خطاها کدهای وضعیت و واکنش درست به هرکدام

# دسته‌بندی سرویس‌ها

دسته کاربرد تعداد سرویس
احراز هویت دریافت توکن دسترسی برای استفاده از API 1
قبض استعلام و پرداخت قبوض، عوارض و جرایم 10
استعلامی و تبدیلی استعلام، تطبیق و تبدیل اطلاعات هویتی و بانکی 32
خدمات پستی استعلام و تبدیل آدرس و کد پستی 4
رهگیری درخواست ها رهگیری وضعیت و نتیجه درخواست‌های ثبت‌شده 2

# اطلاعات پایه

مورد مقدار
آدرس پایه https://zarin-hub.com/api
پیشوند مسیرها /v5/
احراز هویت Authorization: Bearer {ACCESS_TOKEN}

دسترسی هر حساب به سرویس‌ها بر اساس قرارداد و تنظیمات همان حساب تعیین می‌شود.