شروع کار با رابط برنامه نویسی چرتکه

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

تمامی مقادیر ارسالی و دریافتی در وب سرویس های نرم افزار حسابداری چرتکه، از نوع JSON میباشد.

 

شروع به کار:

کلیه درخواست ها به چرتکه از طریق آدرس https://api.chortke.app/v2 ارسال می گردد

 
در معماری نرم افزار چرتکه، دسترسی به متدهای حسابداری نیازمند داشتن کسب و کار فعال در سیستم می باشد. همچنین برای فراخوانی درخواست ها، نیاز به ارسال Token یکتای هر کسب و کار در Header درخواست می باشد.

 

همچنین برای ارسال Token در درخواست های خود، میبایست مقدار Bearer [Token] را در پارامتر Authorization هدر درخواست ارسال نمایید.

برای دریافت Token کسب و کار خود به قسمت تنظیمات/API در پنل حسابداری کسب و کارتان مراجعه نمایید.

پاسخ سرور:

کلیه پاسخ های سرور چرتکه شامل سه پارامتر اصلی زیر می باشند:
 
success: از نوع Boolean و نشان دهنده موفقیت آمیز بودن عملیات می باشد، در صورتیکه درخواست با موفقیت همراه باشد true و در غیر اینصورت false خواهد بود.
message: از نوع String و حاوی پیام مرتبط با موفقیت آمیز بودن عملیات یا خطا در انجام درخواست می باشد.
data: اطلاعات برگردانده شده از سرور در این پارامتر قرار دارد. در صورتیکه درخواست مربوط به گرفتن لیست باشد (مانند گرفتن لیست اشخاص یا محصولات) از نوع Array و در غیر اینصورت Object می باشد.
				
					{
    success: boolean,
    message?: string,
    data?: object || array,
}

				
			
 
نمونه ارسال درخواست و پاسخ دریافتی از سرور چرتکه از طریق JavaScript و کتابخانه JQuery:
				
					            $.ajax({
    url: "https://api.chortke.app/v2/*",
    method: "POST", 
    beforeSend: function (xhr) {
        xhr.setRequestHeader ("Authorization", "Bearer " + BusinessToken);
    },
}).done(function(res) {
    if (res.success){
        console.log(res)
        // {
        //    success: true,
        //    message: 'server message',
        //    data: {...}
        // }
    }
})
.fail(function(err) {
    console.log(err)
});