Français  /  Hulp op afstand  /  API  /  Login  
 


 


 


 


 


 


 


 



Info API voorbeelden

Type api : Json Rest

Request url : https://cloudpos.be/api/?licname=licentienaam&token=verkregentoken&get-products

Categorie, product, subproduct onderscheid : Bekijken

Limiet : 500 connecties per dag, indien er meer requests nodig zijn kan dit worden besproken met onze technische dienst, na 5 verkeerde inlogpogingen word het ip adres voor 30 min geblokkeerd

Logingegevens voor testdoeleinden of een operationele klant kan u aanvragen via info@cloudpos.be

Error :
"errorcode" = 1001 Token and name can not be empty
"errorcode" = 1002 Token or name not valid
"errorcode" = 1003 Limit of '500' requests per day reached, next request possible 'datetime'
"errorcode" = 1004 5 bad logins reached, your ip adress is blocked till 'datetime'
"errorcode" = 1005 No license for this module


Functies


Get Post Update



Categorieen ophalen :

Functie : get-categories

Response :

“id” categorie id
“name” categorie naam

Ok
"success" = 1

Error
"errorcode" = 2000 No categories found






Producten ophalen :

Functie : get-products

Response :

“id” product id
“name” product naam
“categorylink” id van de categorie waarin het product zit ondergebracht
“price” product prijs
“quantity” product stock
“popup” product heeft popup subproducten
“menupopup” product heeft menu subproducten
“openprice” product heeft open prijs
“modtime” laatst aangepast, unix time stamp

Ok
"success" = 1

Error
"errorcode" = 2000 No products found






Subproducten ophalen :

Functie : get-subproducts

Response :

“id” subproduct id
“name” subproduct naam
“price” subproduct prijs
“quantity” subproduct stock
“productlink” array van de product id's waaraan het subproduct is gekoppeld
“modtime” laatst aangepast, unix time stamp

Ok
"success" = 1

Error
"errorcode" = 2000 No subproducts found






Klanten ophalen :

Functie : get-customers

Response :

“id” klant id
“name” naam
“fistname” voornaam
“companyname” firmanaam
“street_number” Straat, nummer
“phone” telefoon
“zipcode” postcode
“town” gemeente
“vatnumber” btwnummer
“email” e-mail adres
“tagid” tag nummer
“tagtype” tag type, barcode of rfid
“tagfamid” tag familie koppeling id
“modtime” laatst aangepast, unix time stamp

Ok
"success" = 1

Error
"errorcode" = 2000 No customers found






Gebruikers ophalen :

Functie : get-users

Response :

“id” gebruiker id
“username” gebruikersnaam
“admin” 1 = admin, 0 = gebruiker
“secnr” rijksregisternummer, enkel in GKS modus

Ok
"success" = 1

Error
"errorcode" = 2000 No users found






Tafels ophalen :

Functie : get-tables

Response :

“id” tafel id
“table” tafelnummer
“status” 0 = niet in gebruik, 1 = in gebruik, 2 = wachten op betaling

Ok
"success" = 1

Error
"errorcode" = 2000 No tables found






Actieve betaalmiddelen ophalen :

Functie : get-payment

Response :

“id” betaalmiddel id
“payment” betaalmiddel naam

Ok
"success" = 1

Error
"errorcode" = 2000 No payment found






Printers ophalen :

Functie : get-printers

Response :

“id” printer id
“printername” printer naam

Ok
"success" = 1

Error
"errorcode" = 2000 No printers found






Orders ophalen :

Functie : get-orders

Url filter :

&start=1   begin bij order id
&end=5   stop bij order id

&date=2016-01-01   selecteer bepaalde datum

&clockinclockout   enkel arbeid in en uit


Response :

“id” order id
“customerid” klant id
“kassaid” kassa id
“totalprice” totaal prijs incl btw
“user” aangemaakt door user id
“ordertime” datum + tijd
“clockin” Arbeid in
“clockout” Arbeid uit
“orderdetail” array van detail lijnen
{
“quantity” aantal
“productid” product id
“productprice” prijs incl btw
“producttax” btw tarief
“subproduct'1-10'id” subproduct id
“subproduct'1-10'price” subproduct incl btw
“subproduct'1-10'tax” subproduct btw tarief
}
“cashpayment” cash betaling
“bancontactpayment” bancontact betaling
“voucherpayment” kadobon betaling
“transferpayment” over te schrijven betaling
“visapayment” visa betaling
“chargecardpayment” oplaadkaart betaling
“luncheoncardpayment” maaltijdcheque betaling
“americanexpresspayment” americanexpress betaling
“mastercardpayment” mastercard betaling

Ok
"success" = 1

Error
"errorcode" = 2000 No orders found






Weborder bevestigd :

Functie : get-confirmedweborder

Post filter :

"weborderid" = nummer van de aangemaakte weborder !!


Response :

"webordertime" = bevestigde tijd wanneer de weborder kan worden afgehaald of word geleverd

Ok
"success" = 1

Error
"errorcode" = 2001 weborder not confirmed
"errorcode" = 2002 weborderid can not be empty
"errorcode" = 2003 weborderid does not exist





Verkoopdocument ondertekend door fdm ophalen :

Functie : get-invoicesigned, get-offersigned, get-creditnotesigned

Post filter :

“documentnr” document nummer !!

Response :

"vatticket" = nummer van het aangemaakte BTW ticket

Ok
"success" = 1

Error
"errorcode" = 2000
"errorcode" = 2001 Document nr can not be empty
"errorcode" = 2002 Document nr already in use





Reservatie beschikbare personen ophalen :

Functie : get-reservationpersons

Post filter :

“date” datum !!

Response :

"persons" = array van aantal personen

Ok
"success" = 1

Error
"errorcode" = 2000
"errorcode" = 2001 Date can not be empty





Reservatie beschikbare uren ophalen :

Functie : get-reservationhours

Post filter :

“date” datum !!
“persons” aantal personen !!

Response :

"hours" = array van beschikbare uren

Ok
"success" = 1

Error
"errorcode" = 2001 Date can not be empty
"errorcode" = 2002 Persons can not be empty





Cadeaubonnen ophalen :

Functie : get-giftvoucher

Response :

“id” Cadeaubon id
“barcode” Barcode
“value” Waarde
“validfrom” Geldig van
“validuntil” Geldig tot
“modtime” Laatst aangepast, unix time stamp

Ok
"success" = 1

Error
"errorcode" = 2000 No vouchers found





Kortingsbonnen ophalen :

Functie : get-coupon

Url filter :

&start=1 begin bij kortingsbon id
&end=5 stop bij kortingsbon id

Response :

“id” Kortingsbon id
“barcode” Barcode
“value” Waarde
“valuetype” 1 geld waarde, 2 percent
“validfrom” Geldig van
“validuntil” Geldig tot
“used” gebruikt

Ok
"success" = 1

Error
"errorcode" = 2000 No coupons found





Klanten tegoed ophalen :

Functie : get-customercredits

Url filter :

&customerid=1 detail van alle tegoed toevoegingen per klant

Response :

“customerid” Klant id
“value” Waarde
“tagid” Tag nummer
“tagtype” Tag type, barcode of rfid

“id” Id (alleen bij customerid filter)
“productid” Product id (alleen bij customerid filter)
“categoryid” Category id (alleen bij customerid filter)

Ok
"success" = 1

Error
"errorcode" = 2000 No customercredits found









  Algemene voorwaarden   -   03 689 77 44   -   info@cloudpos.be   -   vermelde prijzen zijn excl. Btw   -   Syntax Bvba 2017  
  Algemene voorwaarden  - 03 689 77 44 - info@cloudpos.be
vermelde prijzen zijn excl. Btw - Syntax Bvba 2015