لوگوی ایده‌گستران

وب سرویس REST API ایده‌گستران

زیرساخت رسمی تبادل داده و یکپارچه‌سازی نرم‌افزارهای ایده

معرفی وب سرویس

REST API ایده‌گستران امکان تبادل امن و ساخت‌یافته اطلاعات میان نرم‌افزار ایده‌پلاس و سامانه‌های بیرونی را فراهم می‌کند. این وب سرویس مبتنی بر استاندارد REST بوده و از JSON برای تبادل داده استفاده می‌کند.

کاربردهای اصلی وب سرویس

ویژگی‌های فنی

مراحل دریافت دسترسی

  1. ثبت درخواست اتصال از طریق واحد پشتیبانی ایده‌گستران
  2. دریافت ClientId و ClientSecret اختصاصی
  3. دریافت توکن امنیتی از سرویس Auth
  4. ارسال Bearer Token در Header تمامی درخواست‌ها

Swagger-like API

این بخش خلاصه‌ای استاندارد و قابل استناد از وب‌سرویس است و به‌عنوان مرجع فنی برای توسعه‌دهندگان قابل استفاده می‌باشد.

Base Information

Headers مشترک

Authorization: Bearer {accessToken}
Content-Type: application/json

Authentication

Parameter Type Required Description
clientIdstringYesشناسه اختصاصی مشتری
clientSecretstringYesکلید امنیتی مشتری

GET /Items

Parameter Type Required Description
IsBookbooleanYesدریافت کتاب یا غیرکتاب
Station_IdintYesشناسه واحد کاری
Store_IdintYesشناسه انبار
LastItemIdintNoبرای صفحه‌بندی
PageSizeintNoتعداد رکورد خروجی

POST /Factors/Insert

Parameter Type Required Description
station_IdintYesشناسه واحد کاری
store_IdintYesشناسه انبار
factorDatestringYesتاریخ فاکتور
totalPricedecimalYesجمع کل فاکتور
linesarrayYesاقلام فاکتور

Validation Rule: Sum(RowSum) == TotalPrice

Error Codes

Code Meaning
401Unauthorized – توکن نامعتبر
403Forbidden – عدم دسترسی
422Validation Error – خطای اعتبارسنجی
500Server Error

Changelog & Versioning

Version Release Date Changes
v1.1 1404/10/14 افزودن Factors API، بهبود اعتبارسنجی و مستندات Swagger-like
v1.0 1404/08/01 نسخه اولیه احراز هویت، Subjects و Items API

نسخه‌های قدیمی تا ۶ ماه پشتیبانی می‌شوند. برای تغییرات ناسازگار (Breaking Changes) اطلاع‌رسانی قبلی انجام خواهد شد.

نمونه درخواست و پاسخ

دریافت توکن

POST /Auth/Token
Content-Type: application/json

{
  "clientId": "YOUR_CLIENT_ID",
  "clientSecret": "YOUR_CLIENT_SECRET"
}

نمونه پاسخ

{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6..."
}

دانلود مستندات

مستندات کامل وب سرویس شامل توضیح متدها، پارامترها و نمونه‌ها به همراه Postman Collection از طریق لینک‌های زیر قابل دریافت است.


Public Release Notes

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

© ideGostaran.com – کلیه حقوق محفوظ است.