Přeskočit obsah
P
API pro partnery
Napojení vlastní aplikace — přístup, autentizace a endpointy
Reference endpointů / Systém

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 nové heslo — přísný limit
generate-new-password vygeneruje
update-password změní heslo — vlastník

show-phone má limit 20 volání za hodinu z jedné adresy

Je to ochrana proti hromadnému sběru kontaktů.

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 je zaslepená

Vrací neúspěch s kódem 204 a prázdným tělem. Nespoléhejte na ni.

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.

Nastavení odchozí pošty obsahuje přihlašovací údaje

Heslo se nevrací. Nepokoušejte se ho číst.