مستندات فنی

دریافت توکن (Token) :

آدرس : {{Your kavan domain}}/Connect/Token
نوع درخواست : Post
نوع دیتا ارسالی: application/x-www-form-urlencoded
پارامترهای ارسالی :
نام پارامتر نوع پارامتر توضیحات
client_id String نام کلاینت (Client ID) 
client_secret String کلمه عبور کلاینت
grant_type String client_credentials ( متن ثابت )
scope String BMSAPI ( متن ثابت )
مقادیر بازگشتی :
نام پارامتر توضیحات
access_token توکن
expires_in مدت انقضای توکن
token_type نوع توکن
scope BMSAPI ( متن ثابت )
نمونه دیتا ارسالی:

{
  "client_id": "myClientName",
  "client_secret": "myPassword",
  "grant_type": "client_credentials",
  "scope": "BMSAPI"
}

 

ذخیره ساعات کاری (SaveDeviceData) :

آدرس : {{Your kavan domain}}/api/WorkTime/SaveDeviceData
نوع درخواست : Post
نوع دیتا ارسالی: application/json
پارامتر ارسالی :  آرایه ای از اطلاعات ساعت کاری که در ادامه توضیح داده شده است
فیلدهای پارامتر ارسالی :
نام فیلد نوع فیلد توضیحات
xDate DateTime تاریخ ساعت کاری با فرمت MM/dd/yyyy
xTime TimeSpan ساعت ورود یا خروج با فرمت HH:mm به صورت 24 ساعته
xEmployeeCode String کد پرسنلی تعریف شده برای کارمند
مقادیر بازگشتی :
نام پارامتر نوع پارامتر توضیحات
xStatus Boolean صحیح بودن درخواست کلاینت
xMessages String[] پیغام های خطا و توضیحات سرور در صورت موجود بودن
xResult Boolean موفقیت آمیز بودن ذخیره ساعت کاری ها 
نمونه دیتا ارسالی:
		
[
  {
    "xDate": "3/22/2020",
    "xTime": "8:00",
    "xEmployeeCode": "12"
  },
  {
    "xDate": "3/22/2020",
    "xTime": "17:36",
    "xEmployeeCode": "12"
  }
]