Základná URL
https://{tenant}.logzi.com/api/ticket/
Každá požiadavka vracia odpoveď vo formáte JSON. Pri úspešnej odpovedi je result.code == 1, pri chybe result.code == 0. API pre lístky umožňuje vytváranie, overovanie, uplatňovanie a uzatváranie vstupeniek a jednorazovo uplatniteľných kupónových kódov.
/api/ticket/get
Načítanie jedného záznamu lístka podľa identifikátora.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Identifikátor lístka |
Príklad požiadavky
GET /api/ticket/get?id=1
X-API-KEY: {vas_api_kluc}
/api/ticket/get_validate
Overenie platnosti kódu lístka pred uplatnením.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
code | string | Kód lístka, ktorý sa má overiť |
Príklad požiadavky
GET /api/ticket/get_validate?code=TICKET-ABC123
X-API-KEY: {vas_api_kluc}
/api/ticket/list
Stránkovaný zoznam lístkov.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
list_count | int | Maximálny počet vrátených záznamov | |
list_offset | int | Posun stránkovania (predvolené: 0) | |
list_condition | object | Objekt filtrovacích podmienok |
Príklad požiadavky
GET /api/ticket/list?list_offset=0&list_count=50
X-API-KEY: {vas_api_kluc}
/api/ticket/save
Vytvorenie alebo úprava lístka.
POST polia
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
data | object | Základné údaje lístka | |
params | array | Ďalšie parametre |
Príklad požiadavky
POST /api/ticket/save
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{ "data": { "id": 1 } }
/api/ticket/save_validate
Uplatnenie (overenie) kódu lístka.
POST polia — data objekt
V objekte data je potrebné uviesť kód lístka, ktorý sa má uplatniť.
Príklad požiadavky
POST /api/ticket/save_validate
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{ "data": { "code": "TICKET-ABC123" } }
/api/ticket/close
Uzavretie lístka.
POST polia — data objekt
V objekte data je potrebné uviesť identifikátor lístka, ktorý sa má uzavrieť.
Príklad požiadavky
POST /api/ticket/close
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{ "data": { "id": 1 } }
/api/ticket/delete
Vymazanie lístka.
POST polia — data objekt
V objekte data je potrebné uviesť údaje lístka, ktorý sa má vymazať.
Príklad požiadavky
POST /api/ticket/delete
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{ "data": { "id": 1 } }
Zaregistruj sa teraz,
zaplať neskôr!