Webhook API

Kimenő webhook üzenetek kezelése — integrációs esemény-értesítők lekérése és státuszkezelése

Alap URL

https://{tenant}.logzi.com/api/integration_webhook/

Minden kérés JSON választ ad vissza. Sikeres válasz esetén result.code == 1, hiba esetén result.code == 0. A webhook bejegyzések az integráció felé küldendő esemény-értesítőket tárolják (pl. új rendelés, számlakiállítás). A sended mező jelzi, hogy a webhook már el lett-e küldve.

GET /api/integration_webhook/get

Egyetlen webhook bejegyzés lekérése azonosító alapján.

Query paraméterek

ParaméterTípusKötelezőLeírás
idintWebhook bejegyzés azonosítója

Példa kérés

GET /api/integration_webhook/get?id=200
X-API-KEY: {az_api_kulcsod}
GET /api/integration_webhook/list

Webhook bejegyzések lapozható listájának lekérése.

Query paraméterek

ParaméterTípusKötelezőLeírás
list_offsetintLapozás eltolása (alapértelmezett: 0)
list_conditionobjectSzűrési feltételek objektuma

Példa kérés

GET /api/integration_webhook/list?list_offset=0
X-API-KEY: {az_api_kulcsod}
POST /api/integration_webhook/save

Webhook bejegyzés létrehozása vagy módosítása. Módosításkor csak a sended mező frissíthető. Új bejegyzéshez data[id] = 0.

POST mezők — data objektum

MezőTípusKötelezőLeírás
idint0 = új bejegyzés, >0 = módosítás (sended frissítés)
integration_idintIntegráció azonosítója
integration_webhook_type_idintWebhook esemény típusa
receipt_idintKapcsolódó bizonylat azonosítója
receipt_type_idintBizonylat típusa
product_idintKapcsolódó termék azonosítója
requeststringKüldött kérés tartalma (JSON)
request_urlstringKérés URL-je
responsestringKapott válasz tartalma
sendedint1 = elküldve (módosításkor)

Példa kérés

POST /api/integration_webhook/save
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "integration_id": 1,
    "integration_webhook_type_id": 3,
    "receipt_id": 150,
    "receipt_type_id": 2
  }
}
POST /api/integration_webhook/delete

Webhook bejegyzés törlése azonosító alapján.

POST mezők — data objektum

MezőTípusKötelezőLeírás
idintA törlendő webhook azonosítója

Példa kérés

POST /api/integration_webhook/delete
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

{ "data": { "id": 200 } }
POST /api/integration_webhook/close

Webhook bejegyzés lezárása — elküldöttnek jelölés és válasz adatok rögzítése.

POST mezők — data objektum

MezőTípusKötelezőLeírás
idintA lezárandó webhook azonosítója
responsestringKapott válasz tartalma
response_http_codestringHTTP státuszkód

Példa kérés

POST /api/integration_webhook/close
X-API-KEY: {az_api_kulcsod}
Content-Type: application/json

{ "data": { "id": 200, "response_http_code": "200" } }

Vedd fel a kapcsolatot velünk

Érdeklődsz a szoftverünkkel kapcsolatban, írj bátran!

Segítségre van szükséged?

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!

Próbáld ki 3 napig ingyen, kockázatok és kötöttségek nélkül!