Basis-URL
https://{tenant}.logzi.com/api/push/
Jede Anfrage liefert eine JSON-Antwort zurück. Bei Erfolg ist result.code == 1, im Fehlerfall result.code == 0. Die Push-Benachrichtigung ist eine Systemmeldung, die in der mobilen Anwendung angezeigt wird. Sie eignet sich auch zur Benachrichtigung über interne Ereignisse (neue Aufgabe, Statusänderung eines Belegs).
/api/push/get
Abrufen einer einzelnen Push-Benachrichtigung anhand der ID.
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | ID der Push-Benachrichtigung |
Beispielanfrage
GET /api/push/get?id=30
X-API-KEY: {ihr_api_schluessel}/api/push/list
Abrufen einer paginierbaren Liste der Push-Benachrichtigungen mit Filtermöglichkeiten.
Query-Parameter
| Parameter | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
list_offset | int | Versatz für die Seitennummerierung (Standard: 0) | |
list_condition[company_id] | int | Filter nach Firmen-ID | |
list_condition[company_user_id] | int | Filter nach Mitarbeiter-ID | |
list_condition[company_user_id_or_null] | int | Filter nach Mitarbeiter ODER allen (NULL) Benachrichtigungen |
Beispielanfrage
GET /api/push/list?list_condition[company_user_id]=3&list_offset=0
X-API-KEY: {ihr_api_schluessel}/api/push/save
Erstellen einer Push-Benachrichtigung (neuer Eintrag). Bei einem bestehenden Eintrag kann nur der status_id geändert werden. Für eine neue Benachrichtigung data[id] = 0.
POST-Felder — Objekt data
| Feld | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
id | int | 0 = neue Benachrichtigung, >0 = Statusänderung | |
status_id | int | Status der Benachrichtigung | |
company_user_id | int | Zielmitarbeiter (bei NULL: alle Benutzer) | |
partner_id | int | ID des zugehörigen Partners | |
receipt_id | int | ID des zugehörigen Belegs | |
receipt_type_id | int | Belegtyp | |
push_level | int | Wichtigkeitsstufe (1=Info, 2=Achtung, 3=kritisch) | |
push_title | string | Titel der Benachrichtigung | |
push_description | string | Text der Benachrichtigung |
Beispielanfrage
POST /api/push/save
X-API-KEY: {ihr_api_schluessel}
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
}
}Interessierst du dich für unsere Software? Schreib uns einfach!
Jetzt registrieren,
später bezahlen!
