راهنمای فعالسازی وب سرویس (API) حسابداری سپیدار

این مستند شامل راهنمای استفاده از وب سرویس نرم‌افزار سپیدار است و برای مشتریانی ارائه شده که یکی از محصولات زیر را تهیه کرده باشند:

• زیر سیستم موبایل و تبلت سفارش‌گیری
• ارتباط سپیدار و وب سرویس CRM
• وب سرویس فروشگاه اینترنتی

   

در صفحه ورود، مشتریان فقط در صورتی که تیک "اجرای برنامه در حالت سرویس‌دهنده" را بزنند، گزینه "admin" را مشاهده خواهند کرد. این گزینه فقط برای کاربرانی که دسترسی دارند فعال خواهد بود.

پس از ورود به برنامه در حالت سرویس‌دهنده، با فشردن دکمه شروع، سرویس‌دهنده روی پورت ۷۳۷۳ اجرا خواهد شد.
 

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

از این پس، سرویس‌دهنده از طریق آدرس زیر در دسترس خواهد بود:
http://localhost:7373

نکته:
آدرس بالا فقط از داخل همان سیستم قابل دسترسی است. برای دسترسی از طریق اینترنت، مشتری باید IP استاتیک تهیه کند و این موضوع از طریق شرکت ارائه‌دهنده اینترنت پیگیری شود.

تنظیمات پورت سرویس‌دهنده از طریق تنظیمات نرم‌افزار سپیدار قابل تغییر است.

ساختار سرویس

این سرویس با معماری REST تهیه شده است و اطلاعات به‌صورت JSON رد و بدل می‌شود.
احراز هویت در این سیستم با استفاده از JWT انجام می‌شود.

در ادامه این مستند، نحوه ثبت دستگاه، لاگین و معرفی APIها به‌تفصیل توضیح داده خواهد شد.

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

---

راه اندازی اولیه: تعریف دستگاه

از داخل نرم افزار سپیدار، قسمت سفارش گیری و پخش بر روی دستگاه جدید کلیک کنید:

سپس در فرم دستگاه مراحل زیر را طی کنید:

1. یک عنوان برای دستگاه انتخاب کنید.
2. نوع دستگاه را بر اساس قفل خریداری‌شده و نیاز خود انتخاب کنید.
3. با زدن علامت مثبت (+)، یک سطر جدید در جدول اضافه کنید.
4. کاربر مرتبط با این دستگاه را انتخاب کنید.
5. فرم را ذخیره کنید.

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

همچنین، یک QRCode شامل اطلاعات ارتباطی (آدرس سرویس‌دهنده و سریال دستگاه) تولید می‌شود.
از این کد می‌توان برای سهولت در ثبت و ارتباط دستگاه استفاده کرد.

هر بار که روی دکمه "دریافت سریال" کلیک کنید، یک سریال جدید تولید می‌شود و باید عملیات رجیستر مجدداً انجام شود.