مستندات API نرم‌افزار حسابداری سبحان
این مستندات به شما کمک می‌کند تا از APIهای نرم‌افزار حسابداری سبحان برای مدیریت عملیات ثبت فاکتور و به روزرسانی موجودی انبار در فروشگاه خود استفاده کنید. مراحل کار به ترتیب زیر توضیح داده شده است:
۱. ورود به سیستم (Login)
برای ورود به سیستم و دریافت توکن، اطلاعات کاربری خود (نام کاربری و رمز عبور) را ابتدا از طریق نرم افزار حسابداری ابری سبحان از منوی اتصال به API دریافت کرده و سپس از طریق درخواست POST به آدرس زیر ارسال کنید:
آدرس درخواست:
https://api.app.sobhan.net/login
پارامترهای مورد نیاز:
- username: نام کاربری ثبت‌شده در نرم‌افزار.
- password: رمز عبور مرتبط با نام کاربری.
نمونه درخواست:
curl -X POST "https://api.app.sobhan.net/login?username=store_200&password=123456789"
پاسخ سرور:
در صورت موفقیت، سرور یک توکن به همراه اطلاعاتی درباره نیاز یا عدم نیاز به تأیید دومرحله‌ای برمی‌گرداند.
{
"need_two_factor_authentication": false,
"token": "d10eb831ec1cf63ad72acfc463453ed7172cd359"
}
توضیحات پاسخ:
token: توکن احراز هویت برای استفاده در درخواست‌های بعدی.
۲. استفاده از توکن
پس از دریافت توکن، لازم است در تمامی درخواست‌های دیگر این توکن را در هدر درخواست ارسال کنید.
نحوه ارسال توکن در هدر:
هدر: Authorization
مقدار: Token {token}
نمونه:
Authorization: Token d10eb831ec1cf63ad72acfc463453ed7172cd359
3. دریافت موجودی انبار
برای دریافت اطلاعات موجودی یک انبار خاص، از درخواست GET به آدرس زیر استفاده کنید:
آدرس درخواست:
https://api.app.sobhan.net/store/inventory
پارامترهای مورد نیاز:
warehouse: شناسه (شماره) انبار مورد نظر که در منوی انبار در نرم افزار حسابدرای سبحان قابل مشاهده است.
نمونه درخواست:
curl -X GET "https://api.app.sobhan.net/store/inventory?warehouse=251" \
-H "Authorization: Token d10eb831ec1cf63ad72acfc463453ed7172cd359"
پاسخ سرور:
در صورت موفقیت، سرور موجودی انبار را در قالب یک آرایه از کالاها بازمی‌گرداند:
[
{
"ware": "100101001",
"count": "10"
},
{
"ware": "100101002",
"count": "100"
}
]
توضیحات پاسخ:
ware: کد محصول.
count: تعداد موجودی محصول.
4. ارسال فاکتور فروش به نرم‌افزار سبحان
آدرس درخواست POST:
https://api.app.sobhan.net/store/factor
بدنه درخواست (Request Body):
بدنه درخواست باید به صورت JSON و شامل اطلاعات فاکتور باشد:
پارامترهای مورد نیاز:
discount: میزان تخفیف به درصد (اختیاری، اگر نیاز نباشد می‌توانید آن را حذف کنید).
rows: آرایه‌ای از آیتم‌های موجود در فاکتور.
ware: کد کالای مرتبط با نرم‌افزار سبحان.
count: تعداد کالا.
fee: قیمت واحد کالا.
warehouse: شناسه انبار.
نمونه درخواست:
{
"discount": 5,
"rows": [
{
"ware": "100101001",
"count": 1,
"fee": 300000,
"warehouse": 251
}
]
}
پاسخ سرور:
در صورت موفقیت، سرور اطلاعات تأیید فاکتور را برمی‌گرداند:
توضیحات پاسخ:
factor_id: شناسه منحصربه‌فرد فاکتور که توسط سیستم ایجاد شده است.
نکات مهم:
مقدار Token باید همان توکنی باشد که در مرحله ورود دریافت کرده‌اید.
اطلاعات کالاها باید قبلاً در نرم‌افزار تعریف شده باشند.
شناسه انبار باید مرتبط با انبار ثبت‌شده باشد.
{
"factor_id": 12345
}