iBacsTelAPIDevelopersManualv.1.

iBacsTelWEBAPIv1.2 DevelopersManual
GPRS VERSION

iBacsTelAPIDevelopersManualv.1.2

1. Login to control panel

Loginurl:http://ibacstel.com/webapi/user/

Pleaseuseryouraccountdomainnameandpasswordtologin.

2. Dashboard
Onsuccessfullogin,thecontrolpanelwilldisplaythefollowingwindowwiththebasicinformationofthe account.

iBacsTelAPIDevelopersManualv.1.2

3. Account Settings
Usingaccountsettings,youwillbeablereviewyouraccountinformationaswellaseditanyinformationif required.

3.1

Review account information.

3.2

Editing basic information about your company.

Pleaseclickonthe+buttonbytheaccountsettingstoexpandandclickonEditInformationtoeditany informationaboutyouraccount.

iBacsTelAPIDevelopersManualv.1.2

4. Api Settings 4.1 Api Information

ApisettingswillallowyoutoviewtheAPIkeyandthecallbackurl.Itisimportanttomakeanoteofthisasyou willrequirethisonyourprogramming.

4.2

Edit Api Information

UsingtheEditoption,youcaneditthecallbackurlifrequired.

5. Restaurant Settings 5.1 Restaurant List

Alltherestaurantsaddedtotheapiwillbedisplayedonthissection.Youwillbeabletoaddoreditordelete restaurantsfromtherestaurantslist.

iBacsTelAPIDevelopersManualv.1.2

6. Add Restaurant

UsingthisformwewillbeabletoaddrestaurantstotheAPI,wewillneedtoaddeachoftherestaurants individuallytotheAPI.EachrestaurantshouldhavetheiruniqueIDontheirwebsitedatabase.TheAPIwill requestthatIDandwillcreateausernameandpasswordforitandmasktheoriginalrestaurantIDwitha maskingID.ThemaskingIDwillbecomethenewrestaurantsIDfortheAPIandthismaskingIDwillbeusedon theprintertoconfiguretheprintertoconnecttotheAPIandgetorderdetailsaccording. Thefollowinginformationwillberequiredtoaddarestaurant. RestaurantName:[Fillinwithyourrestaurantname] RestaurantID:[putyourrestaurantIDwithyourownwebsitedatabase] Username:[inputanewusername] Password:[inputanewpassword] ConfirmPassword:[reinputthenewpassword] Address:[puttheaddressoftherestaurant,optional] Postcode:[putthepostcodeoftherestaurant,option]

7. Masking ID
ThemaskingIDistheIDthatyouwillbeusingontheprinter,pleasemindthatthismaskingIDisanuniqueID foreachrestaurantyouaddtothesystem.YoucanfindthemaskingIDontherestaurantlistonceyouadded therestaurant,suchasbelow.

iBacsTelAPIDevelopersManualv.1.2

8. Registration for API access

AnAPIkeywithpasswordwillbeavailableafterregistration.Ineachservicerequestfromclientwebsitethese authenticationinformationmustberequired.

9. Add restaurant profile

AftergettingAPIaccessclientneedstoregisterallhisrestaurantsinformationincludingRestaurantID(idthatis usingintheirsitetotrackrestaurantanditsorders)totheAPIwebsitetogetauniquePrinterIDtouseintheir printer.Inthisprocesseachrestaurantwillhaveusernameandpasswordwhichalsoneededforprintersetup.

10.

Post order information from client website

Inthisprocessclientmustsubmitaformwithfollowinginformation: Field importance format details api_key required string APIkeyofclientaccount api_password required string APIpasswordofclientaccount notify_url required string Urlofclientwebsitewheretheapiwillsendthe notificationaftergettingresponsefrompriner.To thisurlapiwillpostaformwithfollowing information: rest_id(restaurantidwhichwassentwhile submittingtheordertoAPIfromclientsite) order_id(thatorderidforwhichthe responsereceivedfromprinter) status(1accepted,2rejected) msg(messagefromprinter) delivery_time(orderdeliverytimereceived fromprinter) rest_id required integer RestaurantIDwhichwasusedinrestaurant registrationintoAPIwebsite.(notuniqueprinterID) order_id required integer OrderIDtotrackorder(mustnotduplicate,that meansmultipleordercantbesenttotheAPIusing sameorderid) currency required string Shortnotationofusedcurrency order_type required integer Ordertype: 1Delivery 2Collection 3Reservation payment_status required integer Statusofthepayment: 6paid 7notpaid payment_method required string Paymentmethodname. Ex.Cash,paypaletc. delivery_time required Dateand Deliverytimeanddateofdelivery. time e.g18:30170910(h:mddmmyy) auth_code optional string Authenticationcodeofpaymentmethod >item_1(string) Requiredat Item_(itemnumber)itisitemname

iBacsTelAPIDevelopersManualv.1.2

leastone >desc_1(string) >qnt_1(integer) >price_1(number) deliverycost card_fee extra_fee total_discount total_amount cust_name cust_address cust_phone cust_instruction isVarified required required optional Optional required required required required optional required number number number number number string string string integer

num_prev_order optional integer Ordersubmiturl(forclientsite):domain/submitorder Orderrequesturl(forprinter):ip/orderrequest.php?a=printerid&u=username&p=password Callbackurl(forprinter): ip/callback.php?a=printerid&o=ordered&ak=accepted/rejected&m=message&dt=deliverytime&u=username&p=password

Desc_(itemnummer)itisitemdescription(ex. Selectionortoppings) Qnt_(itemnumber)itisitemquantity Price_(itemnumber)quantityXunitprice Zeroorgreater Zeroorgreater Zeroorgreater(ex.Orderhandlingfee) Zeroorgreater(ex.Anytypeofpromotion) Zeroorgreater(mustbecalculatedtotalincluding itempriceandotherfeesanddiscount) Customername Customeraddress Customerphonenumber Customerinstructionaboutorder Customerverificationstatus 4verified 5notverified Totalnumberofordersofthiscustomer