API endpoint: /plugin/snippet

Umožňuje přidat vlastní HTML/CSS/JS kód na každou stránku eshopu na určená místa. Možnostmi jsou:

  • header - hlavička stránky
  • footer - patička stránky
  • order-created - prostor na děkovací stránce po vytvoření objednávky

Vytvoření/úprava šablony

POST /plugin/snippet/{entryPoint}

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

Pří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
            'Authorization: Bearer ' . $bearer, // access token
            'Content-Type: application/json'
      ),
    ));

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


Odstranění šablony

DELETE /plugin/snippet/{entryPoint}


Pří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
            'Authorization: Bearer ' . $bearer, // access token
            'Content-Type: application/json'
      ),
    ));

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


Zástupné kódy

Do šablony je možné uvézt zástupné znaky, které budou před vykreslením nahrazeny aktuálními 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 (pouze order-created snippet)