Preskočiť na obsah

REST API

REST API v namespace polski/v1/. Spravujte nastavenia, právne checkboxy, právne stránky a vyhľadávanie produktov.

API vyžaduje autentifikáciu pre endpointy upravujúce údaje (POST, PUT, DELETE). Endpoint vyhľadávania (/search) je dostupný verejne.

Podporované metódy autentifikácie:

  • Application Passwords (WordPress 5.6+) - odporúčané
  • Cookie + nonce - pre požiadavky z admin panelu
  • Basic Auth (s pluginom Basic Auth) - len pre vývoj

Vyžadované oprávnenie: manage_woocommerce (štandardne role Administrator a Manažér obchodu).

Získa všetky skupiny nastavení pluginu.

Oprávnenia: manage_woocommerce

Príklad požiadavky:

Okno terminala
curl -u admin:XXXX-XXXX-XXXX-XXXX \
"https://tvoj-obchod.pl/wp-json/polski/v1/settings"

Príklad odpovede:

{
"groups": [
{
"id": "general",
"label": "Ustawienia ogólne",
"description": "Podstawowa konfiguracja wtyczki"
},
{
"id": "compliance",
"label": "Wymogi prawne",
"description": "Ustawienia wymogów prawa UE i polskiego"
},
{
"id": "storefront",
"label": "Moduły sklepowe",
"description": "Moduły rozszerzające sklep"
},
{
"id": "checkout",
"label": "Kasa i zamówienia",
"description": "Ustawienia kasy i procesu zamówienia"
}
]
}

Získa nastavenia z vybranej skupiny.

Parametre URL:

ParameterTypPopis
groupstringID skupiny nastavení

Oprávnenia: manage_woocommerce

Aktualizuje nastavenia vo vybranej skupine.

Oprávnenia: manage_woocommerce

Príklad požiadavky:

Okno terminala
curl -X POST \
-u admin:XXXX-XXXX-XXXX-XXXX \
-H "Content-Type: application/json" \
-d '{"omnibus_days": 30, "withdrawal_days": 14}' \
"https://tvoj-obchod.pl/wp-json/polski/v1/settings/compliance"

Získa zoznam všetkých právnych checkboxov (pokladňa, registrácia, kontakt).

Oprávnenia: manage_woocommerce

Získa štatistiky akceptácie checkboxov.

Oprávnenia: manage_woocommerce

Získa podrobnosti jednotlivého checkboxu.

Aktualizuje checkbox.

Získa zoznam právnych stránok (obchodné podmienky, zásady ochrany osobných údajov atď.).

Generuje právnu stránku na základe šablóny.

Oprávnenia: manage_woocommerce

Parametre body:

ParameterTypPovinnýPopis
typestringÁnoTyp stránky: terms, privacy, withdrawal, dsa_report
company_namestringÁnoNázov firmy
company_addressstringÁnoAdresa firmy
emailstringÁnoKontaktná e-mailová adresa
phonestringNieTelefónne číslo
nipstringNieNIP firmy

Vyhľadávanie produktov (verejný endpoint).

Parametre query:

ParameterTypPovinnýPopis
qstringÁnoVyhľadávacia fráza
limitintNieLimit výsledkov (štandardne 8)
catintNieID kategórie

Oprávnenia: verejný (nevyžaduje autentifikáciu)

Označí sprievodcu konfiguráciou ako dokončený.

Oprávnenia: manage_woocommerce

KódPopis
200Úspech
201Zdroj vytvorený (POST)
400Nesprávna požiadavka (chýbajúce parametre)
401Chýba autentifikácia
403Chýbajú oprávnenia
404Zdroj nebol nájdený
500Chyba servera

Každý endpoint podporuje WordPress filter umožňujúci upravovať odpoveď:

add_filter('polski/rest/settings_response', function (array $response, WP_REST_Request $request): array {
// Úprava odpovede
return $response;
}, 10, 2);

API neimplementuje vlastný rate limiting. Odporúča sa použitie pluginu alebo konfigurácie servera (napr. Cloudflare, Nginx rate limiting) pre verejné endpointy.

Nahlasovanie problémov: github.com/wppoland/polski/issues

Táto stránka slúži len na informačné účely a nepredstavuje právne poradenstvo. Pred implementáciou sa poraďte s právnikom. Polski for WooCommerce je open source softvér (GPLv2) poskytovaný bez záruky.