Webhook

API endpoint: /webhook

Definované události:

  • order.create - objednávka byla vytvořena
  • order.edit - objednávka byla upravena (např. změna stavu)
  • order.delete - objednávka byla smazána
  • order.cancel - objednávka byla stornována

Všechny Webhooky, které byly vytvořeny doplňky, jsou opatřeny hlavičkou X-Webareal-Signature s hodnotou identifikátoru eshopu (eshopCode).

Strukturu příchozích Webhooků můžete nalézt na této adrese: https://helpdesk.webareal.cz/article-base/webareal-webhook-api-dokumentace
Upozorňujeme, že v článku zmíněná hlavička X-Webareal-Signature, v případě pluginů, obsahuje identifikátor eshopu (eshopCode), nikoliv unikátní podpis vygenerovaný v administraci eshopu.

Vytvoření webhooku

POST /webhook

 
    {
        "name": "plugin-webhook",
        "url": "https://plugin.tld/webhook",
        "isEnabled": true,
        "event": "order.create"
    }

Příklad: 

 
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => 'https://api.webareal.cz/webhook',
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => '',
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 0,
        CURLOPT_FOLLOWLOCATION => true,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => 'POST',
        CURLOPT_POSTFIELDS => json_encode([
            'name' => "plugin-webhook",
            'url' => "https://plugin.tld/webhook",
            'isEnabled' => true,
            'event' => "order.create"
        ]),
        CURLOPT_HTTPHEADER => array(
            'X-Wa-api-token: ' . $api_token, // apiToken získáte při instalaci doplňku, viz. nápověda
            'Authorization: Bearer ' . $bearer, // access token získáte zde, údaje zde (záložka API přístup)
            'Content-Type: application/json'
        ),
    ));

    $response = curl_exec($curl);
    curl_close($curl);
    echo $response;

Aktualizace webhooku

PUT /webhook/{id}

 
    {
        "url": "https://plugin.tld/webhook",
        "isEnabled": true,
    }

Příklad: 

 
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => 'https://api.webareal.cz/webhook/{id}',
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => '',
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 0,
        CURLOPT_FOLLOWLOCATION => true,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => 'PUT',
        CURLOPT_POSTFIELDS => json_encode([
            'name' => "plugin-webhook2",
            'url' => "https://plugin.tld/webhook"
        ],
        CURLOPT_HTTPHEADER => array(
            'X-Wa-api-token: ' . $api_token, // apiToken získáte při instalaci doplňku, viz. nápověda
            'Authorization: Bearer ' . $bearer, // access token získáte zde, údaje zde (záložka API přístup)
            'Content-Type: application/json'
        ),
    ));

    $response = curl_exec($curl);
    curl_close($curl);
    echo $response;

Odstranění webhooku

DELETE /webhook/{id}

Příklad: 

 
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => 'https://api.webareal.cz/webhook/{id}',
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => '',
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 0,
        CURLOPT_FOLLOWLOCATION => true,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => 'DELETE',
        CURLOPT_HTTPHEADER => array(
            'X-Wa-api-token: ' . $api_token, // apiToken získáte při instalaci doplňku, viz. nápověda
            'Authorization: Bearer ' . $bearer, // access token získáte zde, údaje zde (záložka API přístup)
            'Content-Type: application/json'
      ),
    ));

    $response = curl_exec($curl);
    curl_close($curl);
    echo $response;

Zpět