EdeeShop · Implementace

RestApi

Upraveno

Rozšíření, které aktivuje rest API pro frontend i backend data. Více zde.

Konfigurační soubor se standardně nachází v adresáři config/module-edeeshop/features/interface/rest-api.xml.

Příklad konfigurace

xml
<restApi>    <backendApi/>    <frontendApi/>    <rateLimit>        <permitsPerMinute/>        <users>            <user>                <permitsPerMinute/>                <username/>            </user>        </users>        <whitelist>            <username/>        </whitelist>    </rateLimit></restApi>

Popis

restApi

Zapnutí restApi.

VlastnostPopisHodnotaPovinnáVýchozí hodnota
backendApi

Konfigurační možnost pro zapnutí / vypnutí EdeeShop Backend API

backendApi

-

-

frontendApi

Konfigurační možnost pro zapnutí / vypnutí EdeeShop Frontend API.

frontendApi

-

-

rateLimit

Vrací konfiguraci rate limitu.

rateLimit

-

-

backendApi

Konfigurační možnost pro zapnutí / vypnutí EdeeShop Backend API

frontendApi

Konfigurační možnost pro zapnutí / vypnutí EdeeShop Frontend API.

rateLimit

Vrací konfiguraci rate limitu.

VlastnostPopisHodnotaPovinnáVýchozí hodnota
permitsPerMinute

Vrací globalní konfiguraci počtu přístupů pro Rest API uživatele

Integer

-

1000

users

Vrací konfiguraci uživatelů

users

-

-

whitelist

Vrací konfiguraci whitelistu

whitelist

-

-

users

Vrací konfiguraci uživatelů

VlastnostPopisHodnotaPovinnáVýchozí hodnota
user

Seznam uživatelů se specifickým nastaveníám rate limitu

List: user

-

-

user

Seznam uživatelů se specifickým nastaveníám rate limitu

VlastnostPopisHodnotaPovinnáVýchozí hodnota
permitsPerMinute

Počet přístupů na minutu

Integer

-

1000

username

Jméno uživatele

String

-

-

whitelist

Vrací konfiguraci whitelistu

VlastnostPopisHodnotaPovinnáVýchozí hodnota
username

Seznam uživatelů, které nemají nastavený rate-limit

List: String

-

-