Skip to content

Repository files navigation

Packaging: deb

AbraFlexi ClientZone

ClientZone Logo

Klientská zóna napojená na AbraFlexi (dříve FlexiBee). Zákazníci si prohlížejí ceník, objednávají služby, spravují kontaktní údaje a pracují s fakturami a objednávkami — bez přímého přístupu do AbraFlexi.

Administrátor označí v ceníku nabízené položky štítkem ESHOP a AKTIVNI. Poté jsou tyto nabízeny k objednání v katalogu.

Vlastnosti

  • Registrace, přihlášení, změna a obnova hesla
  • Dashboard po přihlášení: souhrn obchodního vztahu (zákazníkem od, celková útrata), neuhrazené faktury (včetně dat upomínek) a nevyřízené objednávky
  • Objednávka položek z ceníku s volitelnými parametry (order pluginy)
  • Košík uložený v session
  • Po objednání vznikají v AbraFlexi doklady (faktura / záloha / objednávka)
  • Historie objednávek a faktur (DataTables)
  • Zobrazení PDF, stažení ISDOC, odeslání dokladu e-mailem
  • Odstoupení od smlouvy (contract.php): zákazník v detailu smlouvy vybere produkty nebo celou smlouvu; produktům se nastaví konec platnosti (platiDoData, u celé smlouvy i smlouvaDo), takže další faktury generované ze smlouvy už tyto položky neobsahují. Poslední fakturovaný den je konec již zafakturovaného období, jinak dnešek. Vystavené faktury zůstávají k úhradě.
  • GDPR správa kontaktních údajů (mycontact.php)
  • Hashování hesel kontaktů v AbraFlexi (volitelné přes .env)

Jazyk zákazníka

Jazyk zvolený v ClientZone určuje jazyk další komunikace se zákazníkem (smlouvy, uvítací e-mail s přístupem do MultiFlexi). Protože adresář v AbraFlexi nemá sloupec pro jazyk, ukládá se při registraci jako štítek firmy LANG_CS, LANG_EN, ... (štítek se podle potřeby založí). Jazyk, který už firma má (např. nastavil obchodník), se pozdější registrací nepřepíše. Čtení: \ClientZone\CustomerLanguage::fromLabels().

Detail produktu a způsob platby

Katalog odkazuje na samostatnou stránku product.php?kod=KÓD s podrobnostmi o produktu. Zákazník na ní hlavně vidí, jak se za produkt platí:

  • Jednorázový nákup - platí se jednou (zboží, materiál, poplatek, kredit),
  • Pravidelně fakturovaná služba - fakturuje se znovu za každé období (měsíc, rok), dokud se smlouva neukončí,
  • Služba - fakturuje se podle jednotky (hodina, GB), víc se neslibuje.

Způsob se určuje v tomto pořadí (první, co něco říká, vyhrává):

  1. štítek položky ceníku RECURRING nebo ONETIME (nejjasnější, nastaví obchodník),
  2. order plugin produktu ($billing - např. MULTIFLEXI je pravidelná služba, KREDIT_DOMENA jednorázový kredit),
  3. jednotka služby: období (MESIC, ROK, ...) znamená pravidelnou fakturaci,
  4. typ zásoby: zboží, materiál a poplatek se kupují jednou.

Typ „Služba“ sám o sobě nestačí (měsíční schránka i hodina školení jsou služby). Proto u pravidelné služby vyplňte v ceníku jednotku (období), ať zákazník ví, za co platí cenu. Zobrazují se jen položky se štítky ESHOP a AKTIVNI.

Údaje dodavatele

Dodavatel je firma, na kterou je v AbraFlexi vedena účetní jednotka. Její údaje jsou v evidenci nastaveni, ale uživatel, pod kterým ClientZone do AbraFlexi přistupuje, je číst nemusí (You don't have permission to this action). Chybějící údaje proto lze nastavit v konfiguraci (.env, stránka setup.php, debconf s nízkou prioritou). Údaj z AbraFlexi má vždy přednost, konfigurace doplní jen to, co AbraFlexi neposkytlo.

Volba Význam Sloupec v nastaveni
SUPPLIER_NAME název nazFirmy
SUPPLIER_IC IČO ic
SUPPLIER_DIC DIČ dic
SUPPLIER_EMAIL e-mail (kam se oznamují změny smluv) email
SUPPLIER_PHONE telefon tel, jinak mobil
SUPPLIER_WEB web www
SUPPLIER_STREET, SUPPLIER_CITY, SUPPLIER_ZIP adresa ulice, mesto, psc
SUPPLIER_NAME="Vítězslav Dvořák"
SUPPLIER_EMAIL="finance@vitexsoftware.cz"

V kódu: \ClientZone\Supplier::load()->get('email'). Prázdná hodnota znamená, že údaj nezná ani AbraFlexi, ani konfigurace; volající se s tím musí vyrovnat (např. upozornění dodavateli přeskočit a zapsat varování).

Moduly pro zpracování objednaných položek

Načítají se ze složky ClientZone/orderplugins/ a jsou potomky \ClientZone\OrderPlugin. Jádro obsahuje obecný plugin Common.php. Kreditové pluginy VoIPcredit.php a DomainCredit.php jsou v balíčku abraflexi-clientzone-spojenet (zdroje v src/ClientZone/orderplugins/).

Plugin může předefinovat:

  • formFields($form) — formulář parametrů položky
  • controlFields($order) — validace odeslaných hodnot
  • processFields($order) — zpracování hodnot
  • settled() — po úhradě faktury s položkou, kterou plugin spravuje

Požadavky

  • PHP 8.1+ (balíček cílí na PHP 8.4)
  • Debian balíčky: php-spojenet-abraflexi, Ease / TWB5 stack, php-vitexsoftware-abraflexi-datatables
  • AbraFlexi API (URL, login, heslo, firma)

Instalace (Debian)

wget -O /etc/apt/keyrings/vitexsoftware.gpg https://repo.vitexsoftware.com/keyring.gpg
echo "deb [signed-by=/etc/apt/keyrings/vitexsoftware.gpg] http://repo.vitexsoftware.com bookworm main" \
  > /etc/apt/sources.list.d/vitexsoftware.list
apt update
apt install abraflexi-clientzone

Aplikace se instaluje do /usr/share/abraflexi-clientzone/ a je dostupná např. jako /clientzone/ (Apache alias z balíčku).

Konfigurace

Debconf / postinst zapíše /etc/abraflexi-client-zone/.env. Příklad klíčů:

ABRAFLEXI_URL="https://flexibee.example.com:5434"
ABRAFLEXI_LOGIN="user"
ABRAFLEXI_PASSWORD="secret"
ABRAFLEXI_COMPANY="firma_s_r_o_"
ABRAFLEXI_PASSWORD_HASH="sha256"
ALLOW_REGISTER="true"
SHOW_PRICELIST="true"
WELCOME_CS="Objednejte domény, VoIP kredit a hosting online — ihned, bez čekání na zpětný telefonát."
WELCOME_EN="Order domains, VoIP credit and hosting online — instantly, without waiting for a callback."
PROD_CAT="1"
EASE_LOGGER="syslog"
EASE_EMAILTO="admin@example.com"
Klíč Význam
ALLOW_REGISTER Povolit registraci nových klientů
REGISTER_USERNAME_IS_EMAIL Přihlašovací jméno musí být shodné s e-mailem (výchozí true)
CLIENTZONE_URL Veřejná adresa aplikace pro odkazy v e-mailech, nutná pro ověření e-mailu
REGISTRATION_SECRET Náhodný tajný klíč (min. 32 znaků) pro odkazy k ověření e-mailu; balíček ho vygeneruje sám
REGISTER_VERIFY_EMAIL Při registraci ověřit e-mailovou schránku odkazem (výchozí false)
SHOW_PRICELIST Zobrazit katalog na úvodní stránce
WELCOME_<LL> Úvodní text na titulní stránce pro jazyk LL (WELCOME_CS, WELCOME_DE, …); fallback WELCOME_EN, pak výchozí text
PROD_CAT ID větve ceníku
ABRAFLEXI_PASSWORD_HASH Hash hesel kontaktů (sha256 / plaintext / prázdné)
SUPPRESS_EMAILS Potlačit odesílání e-mailů klientům

Bezpečnost / role

V ClientZone neexistuje role administrátora. Přihlášení jsou výhradně kontakty AbraFlexi (Customer). Každý uživatel vidí jen doklady a údaje své firmy (GateKeeper + filtr firma v API).

Správa portálu (API klíče, feature flags) probíhá přes SSH úpravou /etc/abraflexi-client-zone/.env nebo přímo v AbraFlexi. Lokální tabulka users / skript create-admin.php se již nepoužívají.

Překlady (i18n)

Gettext doména clientzone, lokalizace v i18n/:

# regenerace šablony a merge
find src -name '*.php' -print0 | xargs -0 xgettext \
  --language=PHP --from-code=UTF-8 --keyword=_ --keyword=gettext \
  --package-name=abraflexi-clientzone -o i18n/clientzone.pot
msgmerge --update i18n/cs_CZ/LC_MESSAGES/clientzone.po i18n/clientzone.pot
msgmerge --update i18n/en_US/LC_MESSAGES/clientzone.po i18n/clientzone.pot
msgfmt -o i18n/cs_CZ/LC_MESSAGES/clientzone.mo i18n/cs_CZ/LC_MESSAGES/clientzone.po
msgfmt -o i18n/en_US/LC_MESSAGES/clientzone.mo i18n/en_US/LC_MESSAGES/clientzone.po

Výchozí locale aplikace je cs_CZ (src/includes/Init.php).

Vývoj

composer install
cp .env.example .env   # nebo vytvořit .env s AbraFlexi údaji
php -S localhost:8080 -t src

Zdrojáky: https://github.com/VitexSoftware/AbraFlexi-ClientZone

© 2017–2026 Vítězslav Dvořák / Vitex Software

Releases

Packages

Used by

Contributors

Languages