مستندات استفاده از API حسابیکس

عنوان داده‌های بازگشتی از API

در حسابیکس داده های بازگشتی به چند بخش تقسیم می شوند.

OerationSuccess

یک سری از API های استاندارد در صورت موفقیت آمیز بودن عملیات یک نمونه مانند کد json زیر را برگشت می دهند.
که با عنوان operationSuccess شناخته می شود.
 return [
            'Success' => true,
            'code' => 0,
            'data' => $data,
            'message' => $message,
        ];
 در نمونه بالا مقدار کد همیشه برابر ۰ و مقدار پارامتر Success باربر با true خواهد بود. پارامتر‌های data,message بر اساس استفاده API متغییر خواهند بود. برای مثال در API دریافت اطلاعات کالا بر اساس بارکد، اطلاعات کالا از طریق data به سمت کاربر برگشت داده میشود.

OperationFail


 return [
            'Success' => false,
            'code' => $code,
            'data' => $data,
            'message' => $message,
        ];

در این نوع بازگشتی مقدار Success برابر false و متغییر ‌های code,data,message به نسبت نیازهای API متغییر خواهد بود. این تابع معمولا در نتیجه شکست در عملیات یا رخداد یک رویداد پیش بینی نشده برگشت داده می شود.
در نظر داشته باشید همیشه می توان با چک کردن مقدار برگشتی Success از دزست بودن عملیات مطمئن شد.

NotFound
return [
            'Success'=>false,
            'code' => 404,
            'data' => $data,
            'message' => 'item not found'
        ];

این نتیجه زمانی صادر می شود که نتیجه عملیات خروجی نداشته باشد.

ParamsNotSend
 return [
            'code' => 101,
            'data' => '',
            'message' => 'parameters not send currectly'
        ];

این نتیجه زمانی صادر می شود که پارامتر های مورد نیاز API به درستی ارسال نشده باشند.
در حسابیکس تعدادی از پارامتر‌ها به صورت post می بایست ارسال شوند و تعدادی از آنها همراه با URL فراخوانی API به درخواست اضافه می شوند که در مورد هر کدام در بخش های مختلف توضیح داده شده است