Alap URL
https://{tenant}.logzi.com/api/push/
Minden kérés JSON választ ad vissza. Sikeres válasz esetén result.code == 1, hiba esetén result.code == 0. A push értesítés a mobilalkalmazásban megjelenő rendszerüzenet. Szintén alkalmazható belső események (új feladat, bizonylat státuszváltás) riasztásakor.
/api/push/get
Egyetlen push értesítés lekérése azonosító alapján.
Query paraméterek
| Paraméter | Típus | Kötelező | Leírás |
|---|---|---|---|
id | int | Push értesítés azonosítója |
Példa kérés
GET /api/push/get?id=30
X-API-KEY: {az_api_kulcsod}/api/push/list
Push értesítések lapozható listájának lekérése szűrési lehetőségekkel.
Query paraméterek
| Paraméter | Típus | Kötelező | Leírás |
|---|---|---|---|
list_offset | int | Lapozás eltolása (alapértelmezett: 0) | |
list_condition[company_id] | int | Szűrés cég azonosítóra | |
list_condition[company_user_id] | int | Szűrés munkatárs azonosítóra | |
list_condition[company_user_id_or_null] | int | Szűrés munkatársra VAGY minden (NULL) értesítésre |
Példa kérés
GET /api/push/list?list_condition[company_user_id]=3&list_offset=0
X-API-KEY: {az_api_kulcsod}/api/push/save
Push értesítés létrehozása (új bejegyzés). Meglévő bejegyzésnél csak a status_id módosítható. Új értesítőhöz data[id] = 0.
POST mezők — data objektum
| Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
id | int | 0 = új értesítő, >0 = státusz módosítás | |
status_id | int | Értesítés státusza | |
company_user_id | int | Célzott munkatárs (ha NULL: minden felhasználó) | |
partner_id | int | Kapcsolódó partner azonosítója | |
receipt_id | int | Kapcsolódó bizonylat azonosítója | |
receipt_type_id | int | Bizonylat típusa | |
push_level | int | Fontossági szint (1=info, 2=figyelem, 3=kritikus) | |
push_title | string | Értesítés címe | |
push_description | string | Értesítés szövege |
Példa kérés
POST /api/push/save
X-API-KEY: {az_api_kulcsod}
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
}
}Érdeklődsz a szoftverünkkel kapcsolatban, írj bátran!
Ha nem találod a választ és szükséged van segítségre
Regisztrációdat hozd létre most,
fizess később!
