Zobrazenie zdroja stránky Zľavové QR kódy pre pokladne

== Url pre volanie API rozhrania ==
<syntaxhighlight lang="html">
https://DOMENA-WEBU/api/register/
</syntaxhighlight>

== Overenie spojenia ==
Pre overenie spojenia sa používa Base HTTP Autentifikácia. Parametre pre prihlásenie (meno a heslo) nastavuje používateľ systému Ellipse v administrácii. Pre produkčné prostredie je potrebné v administrácii povoliť IP adresu pre vzdialený dopyt. Podpora je dostupná na office@horecagroup.sk.

== Zoznam pokladní - registerlist ==
Povinné parametre: type (registerlist)<syntaxhighlight lang="html">
https://demo.ellipsecloud.com/api/register/?type=registerlist
</syntaxhighlight>Odpoveď<syntaxhighlight lang="json">
{
    "1": "Recepcia",
    "2": "Reštaurácia",
    "3": "Lobby bar",
    "4": "Wellness",
    "5": "Reštaurácia kasa 2",
    "6": "Reštaurácia kasa 3",
    "7": "Kiosk"
}
</syntaxhighlight>Pole kde kľúč je ID v systéme Ellipse a hodnota je názov pokladne.

== Vytvorenie zlavy - setsc ==
GET - povinné parametre: '''type''' (setsc)

POST – povinné parametre: '''sale'''(int) - hodnota zľavy, '''type'''(int) -  0 = percent, 1 = suma, '''note'''(string), '''registerid'''(int) – id pokladne z volania registerlist alebo (array) pole s id pokladne pre skuponové vloženie, '''applicability'''(int) - 0 = len na jedno použitie, 1 = opakovane použiteľné. Pri skupinovom vytvorení je pre každé ID pokladne vytvorená zľava uplatniteľná na konkrétnej pokladni. Ak teda pole registered obsahuje ID 3 pokladní, budú vytvorené 3 rôzne kódy (s rovnakým sale, type a applicability) uplatniteľné každý na konkrétnej pokladni. Ak je volanie doplnené o POST regtype=all, bude vytvorená jedna zľava uplatniteľná na každej zo zadaných pokladní.<syntaxhighlight lang="html">
https://demo.ellipsecloud.com/api/register/?type=setsc
</syntaxhighlight>Volanie<syntaxhighlight lang="json">
{
"sale": 10,    
"type": 0,   
"note": "Base sale",  
"registerid": 1 ( alebo [1 , 2] ),
"regtype": "all",  
"applicability": 0
}
</syntaxhighlight>Odpoveď<syntaxhighlight lang="json">
{    
"id": 1,
"code": "S0lPUXlEOUgwMnhuRXhiOXRXUjViZz09",    
"status": "Success"
}
</syntaxhighlight>

== Zoznam zliav - listsc ==
GET - povinné parametre: '''type''' (listsc)

POST – nepovinné parametre: '''registerid'''(int) – id pokladne z volania registerlist, '''fromid'''(int) - filtruje položky s id > ako fromid, '''limit'''(int) - špecifikuje počet záznamov v odpovedi<syntaxhighlight lang="html">
https://demo.ellipsecloud.com/api/register/?type= listsc
</syntaxhighlight>Odpoveď<syntaxhighlight lang="json">
[{ 
"id": "1",    
"code": "ZGQ5VVpuUm1NcXJ1SnB4QTMyeklsUT09",     
"register": "1",
"registeridall": "",     
"sale": "10",     
"type": "0",     
"note": "Base sale",     
"datetime": "2022-09-16 12:44:57"
}]
</syntaxhighlight>

== Zoznam uplatnených zliav - used ==
GET - povinné parametre: '''type''' (used)

POST – nepovinné parametre: '''registerid'''(int) – id pokladne z volania registerlist, '''id'''(int) - id zlavy, '''dateFrom'''(date Y-m-d) a '''dateTo'''(date Y-m-d) - špecifikuje vyhľadávanie v zadanom rozsahu.<syntaxhighlight lang="html">
https://demo.ellipsecloud.com/api/register/?type=used
</syntaxhighlight>Odpoveď<syntaxhighlight lang="json">
[{ 
"id": "1",    
"register": "1",     
"registeridall": "",  
"sale": "10",     
"type": "0",     
"bill": "45669",     
"date": "2022-09-16",
"code": "ZGQ5VVpuUm1NcXJ1SnB4QTMyeklsUT09",  
}]

</syntaxhighlight>

== Zmazanie zľavy - deletesc ==
GET - povinné parametre: '''type''' (deletesc)

POST – povinné parametre: '''id'''(int) – id zlavy<syntaxhighlight lang="html">
https://demo.ellipsecloud.com/api/register/?type=deletesc
</syntaxhighlight>Odpoveď<syntaxhighlight lang="json">
{    
"status": "Success"
}
</syntaxhighlight>