Základná URL
https://{tenant}.logzi.com/api/push/
Každá požiadavka vracia odpoveď vo formáte JSON. Pri úspešnej odpovedi result.code == 1, pri chybe result.code == 0. Push notifikácia je systémová správa zobrazená v mobilnej aplikácii. Dá sa použiť aj na upozornenie na interné udalosti (nová úloha, zmena stavu dokladu).
/api/push/get
Získanie jednej push notifikácie podľa identifikátora.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
id | int | Identifikátor push notifikácie |
Príklad požiadavky
GET /api/push/get?id=30
X-API-KEY: {vas_api_kluc}/api/push/list
Získanie stránkovaného zoznamu push notifikácií s možnosťami filtrovania.
Query parametre
| Parameter | Typ | Povinné | Popis |
|---|---|---|---|
list_offset | int | Posun stránkovania (predvolené: 0) | |
list_condition[company_id] | int | Filtrovanie podľa identifikátora firmy | |
list_condition[company_user_id] | int | Filtrovanie podľa identifikátora zamestnanca | |
list_condition[company_user_id_or_null] | int | Filtrovanie podľa zamestnanca ALEBO všetkých (NULL) notifikácií |
Príklad požiadavky
GET /api/push/list?list_condition[company_user_id]=3&list_offset=0
X-API-KEY: {vas_api_kluc}/api/push/save
Vytvorenie push notifikácie (nový záznam). Pri existujúcom zázname je možné upraviť iba status_id. Pre novú notifikáciu data[id] = 0.
POST polia — objekt data
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | int | 0 = nová notifikácia, >0 = zmena stavu | |
status_id | int | Stav notifikácie | |
company_user_id | int | Cieľový zamestnanec (ak NULL: všetci používatelia) | |
partner_id | int | Identifikátor súvisiaceho partnera | |
receipt_id | int | Identifikátor súvisiaceho dokladu | |
receipt_type_id | int | Typ dokladu | |
push_level | int | Úroveň dôležitosti (1=info, 2=upozornenie, 3=kritické) | |
push_title | string | Názov notifikácie | |
push_description | string | Text notifikácie |
Príklad požiadavky
POST /api/push/save
X-API-KEY: {vas_api_kluc}
Content-Type: application/json
{
"data": {
"id": 0,
"status_id": 1,
"company_user_id": 3,
"push_level": 2,
"push_title": "Új rendelés érkezett",
"push_description": "Webshopból érkezett egy rendelés.",
"receipt_id": 501,
"receipt_type_id": 11
}
}Zaregistruj sa teraz,
zaplať neskôr!
