API endpoint: /plugin/snippet

Umožňuje pridať vlastný HTML/CSS/JS kód na každú stránku eshopu na určené miesta. Možnosťami sú:

  • header - hlavička stránky
  • footer - pätička stránky
  • order-created - priestor na ďakovacej stránke po vytvorení objednávky

Vytvorenie/úprava šablóny

POST /plugin/snippet/{entryPoint}

 
    {
        "snippet": "<div>Hello World</div>"
    }
 

Príklad:

 
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => 'https://api.webareal.cz/plugin/snippet/{entryPoint}',
        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([
            "snippet" => "<div>Hello World</div>"
        ])
        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;
 


Odstránenie šablóny

DELETE /plugin/snippet/{entryPoint}


Príklad:

 
    $curl = curl_init();
    curl_setopt_array($curl, array(
        CURLOPT_URL => 'https://api.webareal.cz/plugin/snippet/{entryPoint}',
        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;
 


Zástupné kódy

Do šablóny je možné uviesť zástupné znaky, ktoré budú pred vykreslením nahradené aktuálnymi hodnotami.

Kód Hodnota Popis
_ESHOP_CODE_ string Identifikátor eshopu
_LANG_ string ISO 639-1 kód jazyka
_ID_ORDER_ int Číslo objednávky (len order-created snippet)