System — uživatelé, platby, nastavení#
Největší modul co do počtu zdrojů.
Každý zdroj nabízí standardní sadu akcí
get, get-by, get-all, save, update-columns, delete, delete-all —
není-li u něj uvedeno jinak. Podrobně CRUD vzor.
Uživatelé#
| Zdroj | Poznámka |
|---|---|
auth |
přihlašovací akce — viz Autentizace |
user |
uživatel — vlastník |
user-role, user-group, user-type |
zařazení |
user-discount-level |
slevová úroveň |
user-payment |
členství |
user-role-privilege |
⛔ nemá HTTP akce |
blacklist, blacklisted-word |
blokace |
login-provider |
přihlášení přes cizí službu |
Zdroj user má akce navíc#
| Akce | Co dělá |
|---|---|
public-profile |
veřejný profil |
show-phone |
odhalí telefon — omezený počet volání |
send-activation-email |
znovu pošle aktivaci |
send-new-password |
pošle na e-mail odkaz pro nastavení nového hesla — přísný limit |
reset-password |
nastaví nové heslo z odkazu; email, key a password jen v těle POST |
generate-new-password |
vygeneruje nové heslo — jen administrátor |
update-password |
změní heslo — vlastník, vyžaduje současné heslo; jen v těle POST, viz Autentizace |
show-phone má limit 20 volání za hodinu z jedné adresy
Je to ochrana proti hromadnému sběru kontaktů.
Zápis účtu#
user/save neprivilegovaného volajícího (host, vlastník) se odmítne:
| Případ | code |
errorCode |
|---|---|---|
typ účtu vyžaduje IČ a název firmy, nebo DIČ, a chybí — kontroluje se, jen když zápis nese typ účtu (userTypeId) |
2 |
userTypeDataMissing |
| nový účet s e-mailem nebo telefonem na blacklistu | 615 |
blacklisted |
| úprava účtu, která změní e-mail nebo telefon na hodnotu z blacklistu | 615 |
blacklisted |
Chybějící pole jsou jen ve zprávě
data nese jen errorCode. Která pole chybí (regId, companyName, vatId), uvádí text
zprávy. Nezměněný e-mail nebo telefon, který se na blacklist dostal později, uložení zbytku
účtu nebrání.
Blacklist a zakázaná slova#
blacklist jsou blokované e-maily, telefony a IP adresy (typ 1 = IP, 2 = e-mail,
3 = telefon). IP adresa může být i rozsah CIDR (IPv4 i IPv6). E-mail se porovnává bez ohledu
na velikost písmen, telefon jen podle číslic (předvolba 00 = +).
Blacklist hlídá zápis od neprivilegovaného volajícího u nových záznamů: komentáře, odběratelé
newsletteru, inzeráty a firemní profily, odpovědi na ně, hlídací psi, kontaktní zprávy,
příspěvky diskuze, reklamace, objednávky, rezervace a nové účty (u úpravy účtu jen změněný
e-mail nebo telefon). Odmítnutí: code: 615, data.errorCode: blacklisted. Administrátor se
nekontroluje.
blacklisted-word je jediný seznam zakázaných slov pro celý web — inzerce, katalog firem
i diskuze ho sdílejí; modulové seznamy neexistují. Slova mají překlady po jazycích a kontrola
bere aktivní slova jazyka stránky požadavku.
Obsah a struktura#
| Zdroj | Poznámka |
|---|---|
page |
stránka — strom, veřejné, akce homepage |
menu, menu-item |
menu — strom, veřejné |
route |
směrování |
admin-page, admin-menu-item |
struktura administrace |
image |
obrázek |
file-system |
⛔ nemá HTTP akce |
Číselníky — veřejné čtení#
language, localization, currency, vat, unit, region (strom),
tariff.
Číselníky si stáhněte jednou a uložte
Mění se zřídka. Volat je při každém požadavku je zbytečné.
Nastavení#
| Akce | Co vrací |
|---|---|
get-public-merged |
veřejné nastavení |
get-merged |
všechno — jen pro oprávněné |
Nesahejte na get-merged bez oprávnění
Vrátí i hodnoty, které nemají být venku.
Platby#
| Zdroj | Poznámka |
|---|---|
payment |
platba + akce create, execute, delivery |
payment-gate, payment-gate-phone |
brány |
payment-region |
platební regiony — veřejné |
payment-status |
stavy |
payment-callback |
obsluha po zaplacení |
payment-transaction |
transakce — jen pro čtení |
payment-error-log |
chyby |
Akce express-execute přijímá SMS od agregátora
Volá ji agregátor platebních SMS s tajemstvím brány a odpovídá prostým textem podle
jeho specifikace. Pro integrace není. Nabídku expresní platby (express-offers) skládá
jen web, HTTP obal nemá.
Návratové adresy z brány vracejí prostý text, ne JSON
Jsou určené prohlížeči, ne vašemu klientovi.
E-maily a upozornění#
email, email-queue, smtp-setting, notification, notification-type,
pdf-template, pdf-template-layout, privilege-group.
notification nese příjemce v poli receiverUserId
null znamená společnou notifikaci pro všechny administrátory. Pole se dřív jmenovalo
userId; starý název už neplatí. Entita ví, komu patří, takže roli receiver lze na
notifikace zapojit.
Napojení třetích stran#
Zdroj external-connection (/api/system/external-connection) drží připojení k cizím
službám — reCAPTCHA, Google Analytics, Tag Manager, Search Console, Maps. Řádek má type,
přepínač enabled a config, což je objekt s hodnotami (klíče, ID).
Jen administrátor — config obsahuje tajné klíče
Žádné čtení není veřejné, ani pro přihlášeného uživatele. Neukládejte odpověď ani ji nelogujte.
Připojení se nezakládá přes API
Nový typ připojení vzniká instalací (kód plus databázový řádek). Přes API se mění jen
enabled a config u už nainstalovaných řádků.
Nastavení odchozí pošty obsahuje přihlašovací údaje
Heslo se nevrací. Nepokoušejte se ho číst.