HTML template
API endpoint: /plugin/snippet
Allows you to add custom HTML/CSS/JS code to each page of the store in designated places. The options are:
-
header- page header -
footer- page footer -
order-created- space on the thank you page after creating an order
Creating/modifying a template
POST /plugin/snippet/{entryPoint}
{
"snippet": "<div>Hello World</div>"
}
Example:
$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;
Removing a template
DELETE /plugin/snippet/{entryPoint}
Example:
$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;
Representative codes
It is possible to enter placeholders into the template that will be replaced by the actual values before rendering.
| Code | Value | Description |
|---|---|---|
_ESHOP_CODE_ | string | Store identifier |
_LANG_ | string | ISO 639-1 language code |
_ID_ORDER_ | int | Order number (only order-created snippet) |