# معرفی زرین‌هاب

زرین‌هاب یک لایه‌ی واسط میان سرویس شما و سامانه‌های مرجع استعلام است. همه‌ی سرویس‌ها با یک آدرس پایه، یک روش احراز هویت و یک قالب پاسخ در دسترس‌اند.

# مشخصات فنی

مورد مقدار
آدرس پایه https://zarin-hub.com/api
پیشوند مسیرها /api/v5/
متد POST
نوع محتوا application/json
احراز هویت Authorization: Bearer {ACCESS_TOKEN}
قالب پاسخ { "meta": { … }, "data": { … } }
عمر توکن دسترسی ۸ ساعت
عمر توکن تمدید یک سال

# گروه‌های سرویس

گروه نمونه سرویس‌ها
احراز هویت و استعلام شاهکار، ثبت احوال، ثنا، شهاب، نظام وظیفه، تشخیص هویت تصویری
بانکی تبدیل کارت/حساب/شبا، تطبیق نام صاحب حساب با کد ملی
چک صیادی استعلام، صدور، انتقال، تأیید و رد چک، رنگ چک
قبض و خلافی قبوض خدماتی، خلافی خودرو و موتور، عوارض آزادراهی و طرح ترافیک
کد پستی و آدرس تبدیل کد پستی به آدرس و برعکس، پیگیری مرسوله
تسهیلات خلاصه و گزارش کامل تسهیلات بانکی
بسته‌های اعتباری ارسال و تأیید رمز بسته اعتباری
پیگیری درخواست وضعیت و جزئیات درخواست‌های ثبت‌شده

فهرست کامل سرویس‌ها با پارامترها و نمونه کد در مستندات API است.

# رفتار زنجیره‌ی تأمین‌کنندگان

هر سرویس می‌تواند به چند تأمین‌کننده‌ی بیرونی متصل باشد که به ترتیب اولویت مرتب شده‌اند. مسیر و قالب پاسخ برای شما ثابت است و تغییر تأمین‌کننده در قرارداد سرویس اثری ندارد.

  • حالت standard (پیش‌فرض): فقط تأمین‌کننده‌ی نخست فراخوانی می‌شود.
  • حالت advanced: در صورت خطای تأمین‌کننده، درخواست روی تأمین‌کننده‌ی بعدی ادامه پیدا می‌کند.

توضیح کامل در شناسه پیگیری و حالت درخواست.

# مدل هزینه

هزینه‌ی هر فراخوانی موفق از اعتبار حساب کسر می‌شود. مبلغ پیش از ارسال درخواست رزرو و پس از پاسخ موفق نهایی می‌شود؛ در صورت شکست، رزرو آزاد می‌شود. جزئیات در اعتبار و تعرفه سرویس‌ها.

# ترتیب مطالعه

  1. ساخت حساب و اعتبارنامه API
  2. فراخوانی اولیه
  3. اعتبار و تعرفه سرویس‌ها
  4. امنیت و محدودسازی IP