Dokumentácia API - Webhooky
Základné informácie
Základné informácie k API, autentizácii, stavovým kódom, HTTP metódam, dátovým typom a ďalšie nájdete na API v2 základné informácie. Všeobecné informácie k webhookom nájdete v článku Webhooky.
Vytvorenie webhooku
Požiadavka
- URI: /api/v2/webhooks
- HTTP metóda: POST
- hlavičky:
- Authorization: Basic dGVzdDp0ZXN0
- Content-Type: application/json
- telo:
- active_yn (bool) - príznak, či je webhook aktívny, východisková hodnota je true
- name (string) - názov webhooku, len pre interné označenie
- url (string) - URL adresa, musí obsahovať schému a doménu (Absolute URI), môže obsahovať aj prihlasovacie údaje,
- event (string) - udalosť, zoznam dostupných udalostí môžete získať pomocou metódy GET /api/v2/webhooks/events
Odpoveď
- telo:
- webhook (object)
- id (int) - ID webhooku
- active_yn (bool) - príznak, či je webhook aktívny
- name (string) - názov webhooku, len pre interné označenie
- url (string) - URL adresa
- event (string) - udalosť
príklad odpovede (HTTP 200 OK)
HTTP/1.1 200 OK
Content-Type: application/json
Aktualizácia webhooku
Požiadavka
- URI: /api/v2/webhooks
- HTTP metóda: PUT
- hlavičky:
- Authorization: Basic dGVzdDp0ZXN0
- Content-Type: application/json
- telo:
- webhooky sa párujú podľa hodnoty id
- id (int) - ID webhooku
- active_yn (bool) - príznak, či je webhook aktívny
- name (string) - názov webhooku, len pre interné označenie
- url (string) - validná URL adresa, môže obsahovať aj prihlasovacie údaje
- event (string) - udalosť, zoznam udalostí môžete získať pomocou metódy GET /api/v2/webhooks/events
príklad požiadavky
PUT /api/v2/webhooks HTTP/1.1
Content-Type: application/json
Authorization: Basic dGVzdDp0ZXN0
Odpoveď
- telo:
- webhook (object)
- id (int) - ID webhooku
- active_yn (bool) - príznak, či je webhook aktívny
- name (string) - názov webhooku, len pre interné označenie
- url (string) - URL adresa
- event (string) - udalosť
príklad odpovede (HTTP 200 OK)
Zmazanie webhooku
- URI: /api/v2/webhooks/?id={id}&ids={ids}
- HTTP metóda: DELETE
- hlavičky:
- Authorization: Basic dGVzdDp0ZXN0
- Content-Type: application/json
- parametre (musí byť definovaný aspoň jeden parameter):
- id (string) - číslo objednávky
- ids (string) - čísla objednávok oddelené bodkočiarkou ;
Odpoveď
- telo:
- webhooks (array) - pole objektov s webhookmi
- id (string) - ID webhooku
- deleted_yn (bool) - príznak, či je webhook zmazaný
- messages (array) - pole objektov chybových správ a upozornení pri spracovaní
- object (string) - názov objektu (časť JSON), ktorého sa správa týka
- property (string) - hodnota, ktorej sa správa týka
- message (string) - text správy
príklad odpovede (HTTP 200 OK)
Zoznam webhookov
- URI: /api/v2/webhooks/{id}
- HTTP metóda: GET
- hlavičky:
- Authorization: Basic dGVzdDp0ZXN0
- Content-Type: application/json
- parametre - slúžia pre filtrovanie výstupu:
- id (string) - ID webhooku
Odpoveď
- telo:
- webhooks (array) - pole objektov s webhookmi
- id (int) - ID webhooku
- active_yn (bool) - príznak, či je webhook aktívny
- name (string) - názov webhooku, len pre interné označenie
- url (string) - URL adresa
- event (string) - udalosť
- last_success_call (datetime) - čas posledného úspešného volania
- last_success_call_status (int) - HTTP status posledného úspešného volania
- last_error_call (datetime) - čas posledného neúspešného volania
- last_error_call_status (int) - HTTP status posledného neúspešného volania
- creation_time (datetime) - čas vytvorenia
príklad odpovede (HTTP 200 OK)
Udalosti webhookov
Vracia zoznam udalostí.
- URI: /api/v2/webhooks/events
- HTTP metóda: GET
- hlavičky:
- Authorization: Basic dGVzdDp0ZXN0
- Content-Type: application/json
- telo:
- events (array) - pole objektov s udalosťami
- name (string) - názov udalosti
- allowed_yn (string) - príznak, či je udalosť pre aktuálneho užívateľa API povolená
príklad odpovede (HTTP 200 OK)