Registrácia Prihlásenie

Webhook API

Správa odchádzajúcich webhook správ — získavanie a správa stavu integračných upozornení na udalosti

Koncové body

Autentifikácia

Ku každej API požiadavke je potrebné odoslať hlavičku X-API-KEY.

X-API-KEY: {vas_api_kluc}

Máte ešte otázky?

Napíšte nám tiket, alebo si pozrite naše centrum pomoci.

Ak sa vám páčilo, podeľte sa s ostatnými

Základná URL

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

Každá požiadavka vracia odpoveď vo formáte JSON. Pri úspešnej odpovedi je result.code == 1, pri chybe result.code == 0. Záznamy webhookov uchovávajú upozornenia na udalosti, ktoré sa majú odoslať smerom k integrácii (napr. nová objednávka, vystavenie faktúry). Pole sended označuje, či už bol webhook odoslaný.

GET /api/integration_webhook/get

Získanie jedného záznamu webhooku podľa identifikátora.

Query parametre

ParameterTypPovinnéPopis
idintIdentifikátor záznamu webhooku

Príklad požiadavky

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

Získanie stránkovateľného zoznamu záznamov webhookov.

Query parametre

ParameterTypPovinnéPopis
list_offsetintPosun stránkovania (predvolené: 0)
list_conditionobjectObjekt s filtrovacími podmienkami

Príklad požiadavky

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

Vytvorenie alebo úprava záznamu webhooku. Pri úprave je možné aktualizovať iba pole sended. Pre nový záznam data[id] = 0.

POST polia — objekt data

PoleTypPovinnéPopis
idint0 = nový záznam, >0 = úprava (aktualizácia sended)
integration_idintIdentifikátor integrácie
integration_webhook_type_idintTyp udalosti webhooku
receipt_idintIdentifikátor súvisiaceho dokladu
receipt_type_idintTyp dokladu
product_idintIdentifikátor súvisiaceho produktu
requeststringObsah odoslanej požiadavky (JSON)
request_urlstringURL požiadavky
responsestringObsah prijatej odpovede
sendedint1 = odoslané (pri úprave)

Príklad požiadavky

POST /api/integration_webhook/save
X-API-KEY: {vas_api_kluc}
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

Odstránenie záznamu webhooku podľa identifikátora.

POST polia — objekt data

PoleTypPovinnéPopis
idintIdentifikátor webhooku, ktorý sa má odstrániť

Príklad požiadavky

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

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

Uzavretie záznamu webhooku — označenie ako odoslané a zaznamenanie údajov odpovede.

POST polia — objekt data

PoleTypPovinnéPopis
idintIdentifikátor webhooku, ktorý sa má uzavrieť
responsestringObsah prijatej odpovede
response_http_codestringHTTP stavový kód

Príklad požiadavky

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

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

Kontaktuj nás

Zaujíma ťa náš softvér? Pokojne nám napíš!

Odoslať dopyt

Potrebuješ pomoc?

Ak nevieš nájsť odpoveď a potrebuješ pomoc

Pozri sa do centra pomoci

Zaregistruj sa teraz,
zaplať neskôr!

Vyskúšaj 3 dni zadarmo, bez rizika a záväzkov!
Vytvorenie registrácie
Registrácia