Dokumentace API - Webhooky

Základní informace

Základní informace k API, autentizaci, stavovým kódům, HTTP metodám, datovým typům a další najdete na API v2 základní informace. Obecné informace k webhookům najdete v článku Webhooky.

Vytvoření webhooku

Požadavek

  • URI: /api/v2/webhooks

  • HTTP metoda: POST

  • hlavičky:

    • Authorization: Basic dGVzdDp0ZXN0
    • Content-Type: application/json
  • tělo:

    • active_yn (bool) - příznak jestli je webhook aktivní, výchozí hodnota je true
    • name (string) - název webhooku, pouze pro interní označení
    • url (string) - URL adresa, musí obsahovat schema a doménu (Absolute URI), může obsahovat i přihlašovací údaje,
    • event (string) - událost, seznam dostupných událostí můžete získat pomocí metody GET /api/v2/webhooks/events
  • příklad požadavku

    POST /api/v2/webhooks HTTP/1.1
    Content-Type: application/json
    Authorization: Basic dGVzdDp0ZXN0
    
    {
        "active_yn": true,
        "name": "",
        "url": "",
        "event": ""
    }

Odpověd

  • tělo:
    • webhook (object)
      • id (int) - ID webhooku
      • active_yn (bool) - příznak jestli je webhook aktivní
      • name (string) - název webhooku, pouze pro interní označení
      • url (string) - URL adresa
      • event (string) - událost
  • příklad odpovědi (HTTP 200 OK)

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "webhook": {
            "id": "",
            "active_yn": "",
            "name": "",
            "url": "",
            "event": ""
        }
    }

Aktualizace webhooku

Požadavek

  • URI: /api/v2/webhooks
  • HTTP metoda: PUT
  • hlavičky:
    • Authorization: Basic dGVzdDp0ZXN0
    • Content-Type: application/json
  • tělo:
    • webhooky se párují podle hodnoty id
    • id (int) - ID webhooku
    • active_yn (bool) - příznak jestli je webhook aktivní
    • name (string) - název webhooku, pouze pro interní označení
    • url (string) - validní URL adresa, může obsahovat i přihlašovací údaje
    • event (string) - událost, seznam událostí můžete získat pomocí metody GET /api/v2/webhooks/events
  • příklad požadavku

    PUT /api/v2/webhooks HTTP/1.1
    Content-Type: application/json
    Authorization: Basic dGVzdDp0ZXN0
    
    {
        "id": "",
        "active_yn": true,
        "name": "",
        "url": "",
        "event": ""
    }

Odpověd

  • tělo:
    • webhook (object)
      • id (int) - ID webhooku
      • active_yn (bool) - příznak jestli je webhook aktivní
      • name (string) - název webhooku, pouze pro interní označení
      • url (string) - URL adresa
      • event (string) - událost
  • příklad odpovědi (HTTP 200 OK)

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "webhook": {
            "id": "",
            "active_yn": "",
            "name": "",
            "url": "",
            "event": ""
        }
    }

Smazání webhooku

  • URI: /api/v2/webhooks/?id={id}&ids={ids}
  • HTTP metoda: DELETE
  • hlavičky:
    • Authorization: Basic dGVzdDp0ZXN0
    • Content-Type: application/json
  • parametry (musí být definovám alespoň jeden parametr):
    • id (string) - číslo objednávky
    • ids (string) - čísla objednávek oddělená středníkem ;

Odpověď

  • tělo:
    • webhooks (array) - pole objektů s webhooky
      • id (string) - ID webhooku
      • deleted_yn (bool) - příznak jestli je webhook smazaný
      • messages (array) - pole objektů chybových zpráv a upozornění při zpracování
        • object (string) - název objektu (část JSONu) kterého se zpráva týká
        • property (string) - hodnota které se zpráva týká
        • message (string) - text zprávy
  • příklad odpovědi (HTTP 200 OK)

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "webhooks": [
            {
                "id": "",
                "deleted": "",
                "messages": [
                    {
                        "object": "",
                        "property": "",
                        "message": ""
                    }
                ]
            }
        ]
    }

Seznam webhooků

  • URI: /api/v2/webhooks/{id}
  • HTTP metoda: GET
  • hlavičky:
    • Authorization: Basic dGVzdDp0ZXN0
    • Content-Type: application/json
  • parametry - slouží pro filtrování výstupu:
    • id (string) - ID webhooku

Odpověď

  • tělo:

    • webhooks (array) - pole objektů s webhooky
      • id (int) - ID webhooku
      • active_yn (bool) - příznak jestli je webhook aktivní
      • name (string) - název webhooku, pouze pro interní označení
      • url (string) - URL adresa
      • event (string) - událost
      • last_success_call (datetime) - čas posledního úspěšného volání
      • last_success_call_status (int) - HTTP status posledního úspěšného volání
      • last_error_call (datetime) - čas posledního neúspěšného volání
      • last_error_call_status (int) - HTTP status posledního neúspěšného volání
      • creation_time (datetime) - čas vytvoření
  • příklad odpovědi (HTTP 200 OK)

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "webhooks": [
            {
                "id": "",
                "active_yn": "",
                "name": "",
                "url": "",
                "event": "",
                "last_success_call": "",
                "last_success_call_status": "",
                "last_error_call": "",
                "last_error_call_status": "",
                "creation_time": ""
            }
        ]
    }

Události webhooků

Vrací seznam událostí.

  • URI: /api/v2/webhooks/events
  • HTTP metoda: GET
  • hlavičky:
    • Authorization: Basic dGVzdDp0ZXN0
    • Content-Type: application/json
  • tělo:
    • events (array) - pole objektů s událostmi
      • name (string) - název události
      • allowed_yn (string) - příznak jestli je událost pro aktuálního uživatele API povolena
  • příklad odpovědi (HTTP 200 OK)

    HTTP/1.1 200 OK
    Content-Type: application/json
    
    {
        "events": [
            {
                "name": "",
                "allowed_yn": ""
            }
        ]
    }
Na této stránce
Zpět

Další zdroje informací

Facebook poradna

Výměna zkušeností, rady a tipy mezi provozovateli e-shopů na systému UPgates.

Přejít do poradny

Akademie

Získejte znalosti od našich specialistů na marketing, obchod, právo a podnikání.

Přejít do akademie

Novinky z Blogu

Co nového jsme pro vás připravili nebo chystáme najdete na blogu.

Přejít do blogu

Nepodařilo se Vám najít tu správnou odpověď?

Kontaktujte naši technickou podporu, která je tu pro vás od pondělí do pátku 8:00 až 16:00 hod.

Zákaznická podpora