معرفی

این مستند شامل مشخصات و راهنماي استفاده از وب سرویس هاي کالا رسانان چاپار می باشد . وب سرویس ها در جهت آسودگی مشتري براي ارسال اطلاعات مرسوله هاي خود به سمت پرتال چاپار می باشند. کاربر پس از استفاده از این وب سرویس توانسته است اطلاعات خود را که ممکن است شامل یک محصول یا تعدادي زیادي محصول باشد را با وب سرویس به سمت پرتال چاپار ارسال نماید و پس از آن شرکت چاپار اطلاعات را مشاهده می نماید و بر اساس اطلاعات هر یک از مرسوله ها اقدام به جمع آوري و توزیع محصولات می نماید و پس از آن مشتري می تواند با استفاده از وب سرویس ها وضعیت تک تک مرسوله هاي خود را پیگیري نماید. در جهت راه اندازي وب سرویس ها حتما باید دانش ارسال اطلاعات با استفاده از JSON فراگرفته شده باشد.
برای دریافت پلاگین وردپرس-ووکامرس اینجا را کلیک کنید
برای دریافت پلاگین چاپ فاکتور وردپرس-ووکامرس اینجا را کلیک کنید
برای مشاهده ویدیو آموزشی نصب افزونه وردپرس-ووکامرس اینجا را کلیک کنید

اطلاعات مورد نیاز قبل از راه اندازي وب سرویس حتما قبل از استفاده از وب سرویس مشتري باید Username و Password داشته باشد. براي دریافت Username و Password با واحد انفورماتیک ( IT ) شرکت کالا رسانان چاپار تماس حاصل نموده و آنها را دریافت نمایید.

وب سرویس ها در یک نگاه

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

apiImage

پست من

اپلیکیشن Postman امکان تست ، اجرا و بررسی کد ها و متد هاي نوشته شده WebAPI را براي ما بسیار آسان می سازد.

در محیط برنامه نویسی وقتی یک API Web را پیاده سازي می کنیم براي تست آن در همان محیط ، ناچاریم کد هایی سمت کلاینت بنویسیم که بتوانیم خروجی آن را بررسی نماییم، یعنی باید کد اصلی که قرار هست بنویسیم را شبیه سازي کنیم، اما همیشه انجام این کار براي ما از نظر زمانی مقرون به صرفه نیست و ما دوست داریم بسیار سریع خروجی برنامه خود را مشاهده کنیم و در زمان هایی که در کد هاي خود تغییر می دهیم به آسانی بتوانیم خروجی و نتیجه تغییرات خود را نیز ملاحظه نماییم. همچنین در برخی از مواقع تست خروجی توسط برنامه اصلی کار دشوار و پر چالشی است. بنابرین وجود یک نرم افزار واسط براي این کار بسیار کارآمد بوده و استفاده از آن به ما کمک شایانی خواهد کرد .

ساختار تمام وب سرویس کالا رسانان چاپار با آدرس CHAPAR_CUSTOMER.postman_collection.json قابل دسترسی می باشد.

جهت استفاده از این آدرس ابتدا باید نرم افزار پست من نصب شده باشد و سپس بتوان ساختار وب سرویس هاي چاپار را مشاهده و تست نمود.

سرویس ها
نام سرویس عدد سرویس
زمینی 1
هوایی 6
پستی 11
چاپار پلاس 35
پاکت 97
نوع ارسال
نام عدد
پیش کرایه 0
پس کرایه 1

در خروجی تمام متدها پراپرتی result , message و object وجود دارد که توضیح آنها به شرح زیر است.

پارامترهای خروجی ثابت
نام پارامتر نوع پارامتر توضیحات
result boolean موفق بودن یا نبودن ریکوئست
message string توضیح علت خطا یا ناموفق بودن ریکوئست
object object نتیجه ی API
POST
Bulk Import
https://app.krch.ir/v1/bulk_import

این متد جهت ارسال اطلاعات یک مرسوله یا تعداد زیادي از مرسولات از این وب سرویس استفاده می گردد.

پارامترهای ورودی
نام پارامتر نوع پارامتر توضیحات
1 username string نام کاربري *
2 password string پسورد *
3 reference string شماره مرجع مشتري *
4 date date تاریخ ارسال اطلاعات به چاپار *
5 pieces_assinged integer تعداد بسته *
6 service integer عدد سرویس *
7 value float ارزش کالا به ریال *
8 term_payment integer نوع ارسال *
9 weight float وزن به کیلو گرم *
10 person string نام شخص گیرنده **
11 company string نام شرکت گیرنده **
12 no_city integer کد شهر گیرنده *
13 telephone string تلفن گیرنده **
14 mobile string موبایل گیرنده **
15 email string ایمیل گیرنده
16 address string آدرس گیرنده *
17 post_code integer کد پستی گیرنده
17 person string نام شخص فرستنده **
18 company string نام شرکت فرستنده **
19 no_city integer کد شهر فرستنده *
20 telephone string تلفن فرستنده **
21 mobile string موبایل فرستنده **
22 email string ایمیل فرستنده
23 address string آدرس فرستنده *
24 post_code integer کد پستی فرستنده
25 content string محتویات
26 note string توضیحات
27 change_state_url string آدرس Callback URL (با تغییر وضعیت بارنامه به این URl اطلاعات وضعیت جدید ارسال میشود.)
28 inv_value double ارزش کالای امانی
مثال

                

                

                    
پارامترهای خروجی

                    

                        

                            
                                

                                    
                                    نام پارامتر
                                    نوع پارامتر
                                    توضیحات
                                

                            
                            
                                

                                    1
                                    tracking
                                    string
                                    شماره بارنامه
                                

                                

                                    2
                                    package
                                    string array
                                    شماره بسته ی متصل به بارنامه
                                

                                

                                    3
                                    reference
                                    string
                                    شماره مرجع مشتری
                                

                                

                                    4
                                    status
                                    string
                                    وضعیت بسته
                                

                                

                                    5
                                    error
                                    array
                                    اخطار ها
                                

                            
                        

                    

                    
مثال

                    

                        

                    

                    

                        
Callback URL :

                        

                            اطلاعات مربوط به وضعیت جدید با نام output به URL ثبت شده با متد POST ارسال میشود.
                        

                        
نمونه data دریافتی :

                        

                            

                        


                    

                

            

            

                

                    

                        
POST / GET

                        
History Report

                    

                    
https://app.krch.ir/v1/bulk_import

                

                
جهت دریافت اطلاعات هر یک از محصولات ثبت شده از این متد استفاده می گردد.

                
پارامترهای ورودی

                

                    

                        
                            

                                
                                نام پارامتر
                                نوع پارامتر
                                توضیحات
                            

                        
                        
                            

                                1
                                username
                                string
                                نام کاربري
                            

                            

                                2
                                password
                                string
                                پسورد
                            

                            

                                3
                                from
                                date
                                تاریخ شروع گزارش
                            

                            

                                4
                                to
                                date
                                تاریخ پایان گزارش
                            

                            

                                5
                                maximum_records
                                integer
                                تعداد خروجی گزارش
                            

                        
                    

                

                
مثال

                

                    

                

                

                    
پارامترهای خروجی

                    

                        

                            
                                

                                    
                                    نام پارامتر
                                    نوع پارامتر
                                    توضیحات
                                

                            
                            
                                

                                    1
                                    tracking
                                    string
                                    شماره بارنامه
                                

                                

                                    2
                                    date
                                    date
                                    تاریخ ارسال اطلاعات به چاپار
                                

                                

                                    3
                                    assinged_pieces
                                    integer
                                    تعداد بسته های بارنامه
                                

                                

                                    4
                                    weight
                                    float
                                    وزن به کیلو گرم
                                

                                

                                    5
                                    service
                                    integer
                                    عدد سرویس
                                

                                

                                    6
                                    value
                                    float
                                    ارزش کالا به ریال
                                

                                

                                    7
                                    payment_term
                                    integer
                                    عدد نوع ارسال
                                

                                

                                    8
                                    last_status
                                    string
                                    آخرین وضعیت بسته
                                

                                

                                    9
                                    delivery_date
                                    date
                                    تاریخ تحویل بسته
                                

                                

                                    10
                                    delivery_person
                                    string
                                    نام توزیع کننده
                                

                                

                                    11
                                    person
                                    string
                                    نام شخص گیرنده
                                

                                

                                    12
                                    company
                                    string
                                    نام شرکت گیرنده
                                

                                

                                    13
                                    city
                                    string
                                    نام شهر گیرنده
                                

                                

                                    14
                                    telephone
                                    string
                                    تلفن گیرنده
                                

                                

                                    15
                                    mobile
                                    string
                                    موبایل گیرنده
                                

                                

                                    16
                                    address
                                    string
                                    آدرس گیرنده
                                

                                

                                    17
                                    post_code
                                    integer
                                    کد پستی گیرنده
                                

                                

                                    18
                                    delivery_charge
                                    float
                                    هزینه توزیع
                                

                                

                                    19
                                    insurance_charge
                                    float
                                    مبلغ بیمه
                                

                                

                                    20
                                    vat_charge
                                    float
                                    مالیات
                                

                                

                                    21
                                    pack_charge
                                    float
                                    هزینه بسته بندی
                                

                                

                                    22
                                    extra_charge
                                    float
                                    هزینه اضافی
                                

                                

                                    23
                                    cod_value
                                    float
                                    هزینه پرداخت موقع تحویل
                                

                                

                                    24
                                    total_charge
                                    float
                                    جمع هزینه ها
                                

                                

                                    25
                                    timestamp_date
                                    
                                    
                                

                                

                                    26
                                    date
                                    date
                                    تاریخ ارسال اطلاعات به چاپار
                                

                                

                                    27
                                    status
                                    string
                                    وضعیت بسته
                                

                                

                                    28
                                    status_note
                                    string
                                    توضیحات وضعیت بسته
                                

                            
                        

                    

                    
مثال

                    

                        

                    

                


            

            

                

                    

                        
POST / GET

                        
Bulk History Report

                    

                    
https://app.krch.ir/v1/bulk_history_report

                

                
دریافت اطلاعات رهگیري N مرسوله در قالب یک گزارش ، با استفاده از این متد
                    می توان اطلاعات رهگیري یک یا چندین بارنامه را دریافت نمود.
                

                
پارامترهای ورودی

                

                    

                        
                            

                                
                                نام پارامتر
                                نوع پارامتر
                                توضیحات
                            

                        
                        
                            

                                1
                                username
                                string
                                نام کاربري
                            

                            

                                2
                                password
                                string
                                پسورد
                            

                            

                                3
                                bulk
                                integer
                                شماره رهگیری مرسوله
                            

                        
                    

                

                
مثال

                

                    

                

                

                    
پارامترهای خروجی

                    

                        

                            
                                

                                    
                                    نام پارامتر
                                    نوع پارامتر
                                    توضیحات
                                

                            
                            
                                
1
                                time
                                time
                                زمان رخ دادن آخرین وضعیت
                                

                                

                                    2
                                    date
                                    date
                                    تاریخ رخ دادن آخرین وضعیت
                                

                                
3
                                status
                                string
                                وضعیت بسته
                                

                                

                                    4
                                    status_note
                                    string
                                    توضیحات وضعیت بسته
                                

                                

                                    5
                                    tracking
                                    string
                                    شماره بارنامه
                                

                                

                                    6
                                    reference
                                    string
                                    شماره مرجع مشتری
                                

                            
                        

                    

                    
مثال

                    

                        

                    

                

            

            

                

                    

                        
POST / GET

                        
Cancel Pickup

                    

                    
https://app.krch.ir/v1/cancel_pickup

                

                
جهت حذف سفارش از این متد استفاده میشود .
                

                
پارامترهای ورودی

                

                    

                        
                            

                                
                                نام پارامتر
                                نوع پارامتر
                                توضیحات
                            

                        
                        
                            

                                1
                                username
                                string
                                نام کاربري
                            

                            

                                2
                                password
                                string
                                پسورد
                            

                            

                                1
                                consignment_no
                                string
                                شماره بارنامه
                            

                            

                                2
                                reason
                                string
                                دلیل انصراف
                            

                        
                    

                

                
مثال

                

                    

                

         

            
            

                

                    

                        
POST / GET

                        
Get State

                    

                    
https://app.krch.ir/v1/get_state

                

                
جهت دریافت لیست استان هایی که تحت پوشش شرکت چاپار می باشند از این متد
                    استفاده می گردد.

                
پارامترهای ورودی

                

                    

                        
                            

                                
                                نام پارامتر
                                نوع پارامتر
                                توضیحات
                            

                        
                        
                            

                                
                                -
                                -
                                -
                            

                        
                    

                

                

                    ساختار تعریف شده اي براي این متد وجود ندارد و با فراخوانی آدرس سرویس همین متد می توان لیست استانها
                    را دریافت نمود.
                

                
                

                    
پارامترهای خروجی

                    

                        

                            
                                

                                    
                                    نام پارامتر
                                    نوع پارامتر
                                    توضیحات
                                

                            
                            
                                
1
                                no
                                integer
                                آیدی استان
                                

                                

                                    2
                                    name
                                    string
                                    نام استان
                                

                            
                        

                    

                    
مثال

                    

                        

                    

                

            

            

                

                    

                        
POST / GET

                        
Get City

                    

                    
https://app.krch.ir/v1/get_city

                

                
جهت دریافت لیست شهرهایی که تحت پوشش شرکت چاپار می باشند را با استفاده
                    از این متد دریافت نمایید.

                
پارامترهای ورودی

                

                    

                        
                            

                                
                                نام پارامتر
                                نوع پارامتر
                                توضیحات
                            

                        
                        
                            

                                1
                                no
                                integer
                                آیدی استان مورد نظر که از متد دریافت استان گرفته شده است.
                            

                        
                    

                

                
مثال

                

                    

                

                


                    
پارامترهای خروجی

                    

                        

                            
                                

                                    
                                    نام پارامتر
                                    نوع پارامتر
                                    توضیحات
                                

                            
                            
                                

                                    1
                                    state_no
                                    integer
                                    آیدی استان
                                

                                

                                    2
                                    no
                                    integer
                                     آیدی شهرهای استان
                                

                                

                                    3
                                    name
                                    string
                                    نام شهرهای استان 
                                

                            
                        

                    

                    
مثال

                    

                        

                    

                

            

            

                

                    

                        
POST / GET

                        
Get Quote

                    

                    
https://app.krch.ir/v1/get_quote?input=

                

                
جهت استعلام قیمت از این متد استفاده میشود .

                
پارامترهای ورودی

                

                    

                        
                            

                                
                                نام پارامتر
                                نوع پارامتر
                                توضیحات
                            

                        
                        
                            

                                1
                                origin
                                integer
                                آیدی شهر مبدا
                            

                            

                                2
                                destination
                                integer
                                آیدی شهر مقصد
                            

                            

                                3
                                method
                                integer
                                نوع سرویس
                            

                            

                                4
                                value
                                float
                                ارزش کالا به ریال
                            

                            

                                5
                                weight
                                float
                                وزن به کیلو گرم
                            

                        
                    

                

                
مثال

                

                    

                

                

                    
پارامترهای خروجی

                    

                        

                            
                                

                                    
                                    نام پارامتر
                                    نوع پارامتر
                                    توضیحات
                                

                            
                            
                                

                                    1
                                    quote
                                    integer
                                    جمع هزینه پرداختی
                                

                                

                                    2
                                    zone
                                    integer
                                    نوع محدوده
                                

                                

                                    3
                                    fld_Manual_Cost
                                    float
                                    کرایه حمل
                                

                                

                                    4
                                    fld_Pack_Cost
                                    float
                                    کرایه بسته بندی
                                

                                

                                    5
                                    fld_Charge_Cost
                                    float
                                    کرایه خدمات
                                

                                

                                    6
                                    fld_Manual_Insurance
                                    float
                                    بیمه
                                

                                

                                    7
                                    fld_Lab_Cost
                                    float
                                    سوخت
                                

                                

                                    8
                                    fld_Manual_VAT
                                    float
                                    ارزش افزوده
                                

                                

                                    9
                                    fld_Total_Cost
                                    float
                                    جمع کل
                                

                                

                                    10
                                    price_list
                                    integer
                                    
                                

                                

                                    11
                                    min_ins
                                    integer
                                    حداقل بیمه
                                

                                

                                    12
                                    currency
                                    integer
                                    واحد پولی
                                

                            
                        

                    

                    
مثال

                    

                        

                    

                

            

            

                

                    

                        
POST / GET

                        
Tracking

                    

                    
https://app.krch.ir/v1/tracking?input=

                

                
جهت پیگیري مرسوله ارسالی از این متد استفاده میشود .
                

                
پارامترهای ورودی

                

                    

                        
                            

                                
                                نام پارامتر
                                نوع پارامتر
                                توضیحات
                            

                        
                        
                            

                                1
                                reference
                                string
                                شماره مرجع مشتری
                            

                            

                                2
                                lang
                                string
                                زبان خروجی
                            

                        
                    

                

                
مثال

                

                    

                

                

                    
پارامترهای خروجی

                    

                        

                            
                                

                                    
                                    نام پارامتر
                                    نوع پارامتر
                                    توضیحات
                                

                            
                            
                                

                                    1
                                    delivered_to
                                    string
                                    مشتری گیرنده
                                

                                

                                    2
                                    delivery_time
                                    time
                                    زمان مصرف شده
                                

                                

                                    3
                                    signature
                                    img
                                    امضا مشتری
                                

                                

                                    4
                                    lat
                                    float
                                    عرض جغرافیایی
                                

                                

                                    5
                                    lng
                                    float
                                    طول جغرافیایی
                                

                                

                                    6
                                    timestamp_date
                                    timestamp
                                    تاریخ رخداد وضعیت
                                

                                

                                    7
                                    date
                                    date
                                    تاریخ ارسال اطلاعات به چاپار
                                

                                

                                    8
                                    status
                                    string
                                    وضعیت بسته
                                

                                

                                    9
                                    loc
                                    lat.lng
                                    مکان رخداد وضعیت
                                

                                

                                    10
                                    origin
                                    string
                                    مبدا
                                

                                

                                    11
                                    dest
                                    string
                                    مقصد
                                

                                

                                    12
                                    pickup_agent_code
                                    string
                                    کد نماینده جمع آوری
                                

                                

                                    13
                                    pickup_agent
                                    string
                                    نماینده جمع آوری
                                

                                

                                    14
                                    delivery_agent_code
                                    string
                                    کد نماینده توزیع
                                

                                

                                    15
                                    delivery_agent
                                    string
                                    نماینده توزیع
                                

                                

                                    16
                                    sender_code
                                    string
                                    کد مشتری ارسال کننده
                                

                                

                                    17
                                    sender_company
                                    string
                                    شرکت ارسال کننده
                                

                                

                                    18
                                    sender_contact
                                    string
                                    مشتری ارسال کننده
                                

                                

                                    19
                                    sender_phone
                                    text
                                    تلفن ارسال کننده
                                

                                

                                    20
                                    receiver_company
                                    string
                                    شرکت تحویل گیرنده
                                

                                

                                    21
                                    receiver_contact
                                    string
                                    مشتری تحویل گیرنده
                                

                                

                                    22
                                    receiver_phone
                                    string
                                    شماره مشتری تحویل گیرنده
                                

                            
                        

                    

                    
مثال