Flaem

Moduł Flaem dla WHMCS: WHMCS liczy pieniądze, Flaem prowadzi serwery

Jeśli Twoi klienci płacą w WHMCS i tak ma zostać, nie musisz go wyłączać. Moduł Flaem podpinasz w WHMCS jak każdy moduł serwera: opłacone zamówienie zakłada serwer gry, VPS albo stronę we Flaem, a klient zarządza usługą w panelu Flaem, do którego wchodzi jednym kliknięciem z WHMCS.

WHMCS
WHMCSklient i pieniądze
  • Dane klienta i zamówienia
  • Faktury i płatności
  • Okres rozliczeniowy
  • Windykacja i zawieszanie za brak wpłaty
Create
API mostu rozliczeń
powiadomienia zwrotne
Flaem
Flaemmaszyna
  • Serwer gry, VPS, kontener LXC albo strona WWW
  • Panel klienta z konsolą, plikami i kopiami
  • Węzły, pojemność i monitoring
  • Zakładanie, zmiana pakietu i wygaszanie
01Podział pracy

Usługa z WHMCS we Flaem: co Flaem robi, a czego nie dotyka

Usługa założona przez moduł jest we Flaem oznaczona jako rozliczana w WHMCS. Działa na tych samych węzłach, z tymi samymi kopiami, limitami i panelem co usługa kupiona w sklepie Flaem. Pieniądze zostają w całości po stronie WHMCS.

Tak samo jak usługa ze sklepu Flaem

  • Te same węzły i ten sam harmonogram rozmieszczania
  • Sprawdzenie pojemności i poziomu sprzętu przed założeniem
  • Te same polecenia zakładania i ta sama kolejność wygaszania
  • Każda akcja w dzienniku zdarzeń panelu operatora

Czego Flaem dla niej nie robi

  • Nie wystawia faktur, nawet zerowych, i nie pokazuje jej na liście faktur klienta
  • Nie przypomina o odnowieniu i nie zawiesza za brak wpłaty
  • Nie pobiera pieniędzy z portfela, także przy zmianie pakietu
  • Nie pokazuje klientowi daty ani przycisku odnowienia, tylko to, kto rozlicza usługę

Jeśli klient nie zapłaci, usługę zawiesza WHMCS, a moduł przekazuje to do Flaem. Flaem nie zawiesi jej sam ani wbrew WHMCS.

02Akcje

Akcje WHMCS i to, co robią we Flaem

Moduł obsługuje akcje, które WHMCS wykonuje na usłudze z panelu administratora, z kolejki modułu i z codziennego crona. Każda trafia do API mostu rozliczeń Flaem i każda kończy się jasną odpowiedzią w WHMCS.

  1. CreateŁączy klienta WHMCS z kontem we Flaem, a przy pierwszym zamówieniu zakłada to konto z jego adresu e-mail. Potem zakłada usługę na węźle.POST /services
  2. SuspendZatrzymuje usługę z powodem "brak płatności" i opisem z WHMCS. Dane zostają nietknięte.POST /services/{id}/suspend
  3. UnsuspendWznawia usługę po wpłacie.POST /services/{id}/unsuspend
  4. TerminateWygasza usługę, a przed usunięciem otwiera klientowi okno na pobranie danych.POST /services/{id}/terminate
  5. Change PackagePrzenosi usługę na nowy pakiet z opcjami wybranymi w WHMCS.POST /services/{id}/package
  6. Log in to panelTworzy jednorazowy link logowania w chwili kliknięcia, dla klienta i dla administratora.POST /services/{id}/sso
  7. Obszar klientaPokazuje stan, pakiet i zużycie usługi, czytane na żywo z Flaem.GET /services/{id}
  8. Usage UpdateZapisuje w WHMCS zużycie dysku i transferu. Gdy Flaem nie ma pomiaru, usługa jest pomijana, a nie zerowana.GET /services/{id}/usage

Odmowa trafia do WHMCS w całości

Gdy Flaem czegoś nie zrobi, WHMCS dostaje kod odmowy, zdanie z wyjaśnieniem i listę tego, czego brakuje: w dzienniku modułu, w komunikacie w panelu administratora i w kolejce modułu. Klucz mostu jest w dzienniku skrócony do publicznego prefiksu.

03Synchronizacja

Synchronizacja usług w obie strony

WHMCS wydaje polecenia, a Flaem odpowiada stanem usługi. Gdy operator zawiesi albo anuluje usługę w panelu Flaem, podpisane powiadomienie zwrotne zmienia ją także w WHMCS, więc oba systemy pokazują to samo.

Z WHMCS do Flaem

  • Polecenia: założenie, zawieszenie, wznowienie, wygaszenie i zmiana pakietu
  • Odczyt stanu, pakietu i zużycia na żywo w obszarze klienta
  • Codzienny cron WHMCS zapisuje zużycie dysku i transferu

Z Flaem do WHMCS

  • Powiadomienia o zawieszeniu, wznowieniu i anulowaniu w panelu Flaem
  • Każde podpisane sekretem i wysyłane wyłącznie na adres https
  • Sekret zapisany zaszyfrowany w polu serwera WHMCS

Sześć stanów usługi, które rozumie moduł

  1. provisioningPrzyjęta, węzeł ją zakłada
  2. activeDziała
  3. suspendedZatrzymana, dane nietknięte, do wznowienia
  4. terminatingW trakcie wygaszania
  5. terminatedUsunięta
failedZakładanie się nie udało, z przyczyną podaną przez węzeł

Ponowienie po przekroczeniu czasu nie buduje drugiej maszyny

Każde polecenie zmieniające usługę niesie klucz idempotencji zbudowany z numeru usługi w WHMCS i rodzaju akcji, a nie z numeru próby. Gdy kolejka WHMCS ponowi akcję po przekroczeniu czasu, Flaem oddaje pierwszą odpowiedź zamiast zakładać drugą maszynę.

Pierwsza próbaten sam klucz
Ponowienie z kolejkiten sam klucz
Jedna maszyna

Klucz mostu ma domyślnie 600 zapytań na minutę, więc nocny cron WHMCS przechodzi przez wszystkie usługi. Każde wywołanie widać w dzienniku API panelu pod prefiksem klucza.

Most rozliczeniowy z WHMCS: kombinacje opcji przypisane do pakietów, stany usług i ostatnie wywołania mostu
04Katalog

Produkt z opcjami w WHMCS, ustalony pakiet we Flaem

WHMCS sprzedaje produkt z opcjami konfigurowalnymi, a Flaem ustalone pakiety. Odwzorowujesz całą kombinację opcji, nie każdą opcję osobno: pamięć 4, 8 albo 16 GB w dwóch lokalizacjach to sześć pakietów i sześć wierszy w katalogu mostu.

Pamięć / LokalizacjaFrankfurtWarszawa
4 GB
location=fra;ram=4096Pakiet 1
location=waw;ram=4096Pakiet 2
8 GB
location=fra;ram=8192Pakiet 3
location=waw;ram=8192Pakiet 4
16 GB
location=fra;ram=16384Pakiet 5
location=waw;ram=16384Pakiet 6

Pakiet 8 GB we Frankfurcie to inny pakiet niż 8 GB w Warszawie: inny sprzęt, a czasem inny dysk. Dlatego most nie składa odpowiedzi z pojedynczych opcji.

Nazwy i wartości opcji są ujednolicane przed wyszukaniem, więc wielkość liter, spacje i kolejność opcji nie mają znaczenia.

Kombinacja bez odwzorowania jest odrzucana, a nie zgadywana

Most nie dobiera najbliższego pakietu, bo oznaczałoby to maszynę, której klient nie kupił. Odmowa mówi dokładnie, którego wiersza brakuje.

Kod odmowy
option_not_mapped
Co przysłał WHMCS
location=fra;ram=8192
Co jest odwzorowane w produkcie
location=fra;ram=4096, location=waw;ram=8192

Dodajesz brakujący wiersz w katalogu i ponawiasz akcję z kolejki modułu. Ponowienie po odmowie jest nowym zapytaniem, a nie powtórką odmowy.

05Logowanie

Logowanie do panelu Flaem prosto z WHMCS

Przycisk logowania w obszarze klienta WHMCS tworzy jednorazowy link w chwili kliknięcia. Klient trafia do panelu Flaem bez osobnego hasła, a administrator tak samo wchodzi z karty usługi.

  1. 0 s

    Kliknięcie w WHMCS

    Moduł prosi Flaem o link dla tego klienta i tej usługi.

  2. Link w pasku adresu

    Działa jeden raz. Flaem przechowuje tylko jego skrót.

  3. Panel Flaem

    Klient jest zalogowany. Jeśli ma weryfikację dwuetapową, panel pyta o drugi składnik.

  4. 120 s

    Link wygasa

    Po 2 minutach albo po pierwszym użyciu. Nieznany, wygasły i zużyty link dostają tę samą odmowę.

  • Konto we Flaem powstaje przy pierwszym zamówieniu, z adresu e-mail klienta i bez hasła.
  • Klient może później ustawić hasło w ustawieniach konta jako drugie wejście.
  • Każde użycie linku trafia do dziennika z adresem, z którego go użyto.
  • Most pozwala wydłużyć życie linku do 15 minut, na przykład dla wiadomości z kolejki e-mail.
Panel serwera Minecraft: zużycie na żywo, wykres graczy i konsola
06Instalacja

Instalacja modułu w ośmiu krokach

Moduł to jeden plik zip, wydawany z każdą wersją Flaem razem z sumą kontrolną. Nie potrzebuje Composera ani dodatkowych bibliotek, bo korzysta tylko z tego, co jest już w WHMCS.

Wymagania

  • WHMCS 8 na PHP 7.4 lub nowszym, z rozszerzeniem cURL
  • Panel Flaem dostępny z serwera WHMCS przez HTTPS
  • Konto administratora Flaem z uprawnieniem do zarządzania rozliczeniami
  1. 1

    Pobierz i sprawdź plik

    Pobierasz archiwum i plik z sumą kontrolną, a potem porównujesz je jednym poleceniem.

    sha256sum -c flaem-whmcs-1.0.0.zip.sha256
  2. 2

    Rozpakuj do katalogu WHMCS

    Archiwum ma już ścieżkę modules/servers/flaem, więc niczego nie przenosisz.

    unzip flaem-whmcs-1.0.0.zip -d /var/www/whmcs
  3. 3

    Wygeneruj poświadczenie mostu

    W panelu Flaem: Most rozliczeniowy, karta Poświadczenia, system rozliczeń whmcs. Klucz widać tylko raz i działa wyłącznie na most.

  4. 4

    Odwzoruj produkty

    Na karcie Katalog przypisujesz każdą kombinację opcji produktu WHMCS do pakietu Flaem.

  5. 5

    Dodaj serwer w WHMCS

    Moduł Flaem, adres panelu i klucz mostu w polu hasła. Test połączenia sprawdza klucz, uprawnienie, bazę panelu i wersję kontraktu mostu.

  6. 6

    Ustaw produkty

    Wybierasz pakiet Flaem, sposób przekazywania opcji i nazwę usługi widoczną dla klienta. Natychmiastowe usuwanie zostaw wyłączone: klient dostaje wtedy okno na pobranie danych, którego wymaga art. 25 ust. 2 rozporządzenia (UE) 2023/2854.

  7. 7

    Zarejestruj powiadomienia zwrotne

    Jedno polecenie na serwer WHMCS. Sekret do podpisów zapisuje się zaszyfrowany w polu serwera.

    php modules/servers/flaem/tools/callback-register.php https://<adres-whmcs>
  8. 8

    Zużycie liczy się samo

    Codzienny cron WHMCS zapisuje zużycie dysku i transferu. Dziennik modułu pokazuje, które usługi zmierzono, a które pominięto i dlaczego.

Aktualizacja to rozpakowanie nowego archiwum na stare. Tabele modułu zostają nietknięte i nic więcej nie trzeba uruchamiać.

07Pełny Flaem

Droga do pełnego Flaem, usługa po usłudze

Moduł nie zamyka drogi do przejścia w całości. Działający hosting przechodzi etapami: najpierw panel, potem klienci i rozliczenia, bez jednego weekendu, w którym zmienia się wszystko naraz.

  1. 1

    Moduł

    Nowe zamówienia z WHMCS zakładają usługi we Flaem. Klienci płacą jak dotąd, a usługami zarządzają w panelu Flaem.

  2. 2

    Przekazanie istniejących usług

    Usługi, które Flaem już prowadzi, na przykład po imporcie z Pterodactyla, przekazujesz WHMCS jedna po drugiej. Maszyna zostaje na miejscu, a okres, faktury i windykację przejmuje WHMCS.

  3. 3

    Import z WHMCS

    Klienci z profilem i saldem portfela, terminy i kwoty odnowień oraz faktury jako archiwum przechodzą do Flaem. Najpierw próba na sucho z raportem, a WHMCS jest w tym czasie tylko czytany.

  4. 4

    Rozliczenia we Flaem

    Każdą usługę przejmujesz na rozliczenia Flaem jednym przyciskiem i wpisujesz w cykl rozliczeniowy. Od tej chwili fakturuje ją Flaem, z wysyłką do KSeF.

Moduł usuwasz po przeniesieniu produktów z grupy serwerów Flaem. Maszyny działają dalej, a powiązania zostają w panelu, dopóki ich nie przejmiesz albo nie rozłączysz.

08Inne systemy

Ten sam most dla Blesty, HostBilla i Paymentera

Moduły dla pozostałych systemów korzystają z tego samego API mostu i mają ten sam zestaw akcji: zakładanie, zawieszanie, wznawianie, wygaszanie i zmianę pakietu. Różnią się tym, gdzie je instalujesz.

  • Blesta
    BlestaModuł serwera i wtyczka flaem_bridge do powiadomień zwrotnych.components/modules/flaem
  • HostBill
    HostBillModuł hostingowy HostBilla.includes/modules/Hosting/flaem
  • Paymenter
    PaymenterRozszerzenie serwerowe Paymentera.extensions/Servers/Flaem
09Pytania

Pytania o moduł Flaem dla WHMCS

Instalacja, faktury, logowanie klientów i to, co dzieje się po usunięciu modułu.

Nie. To jeden plik zip z bezpośredniego linku, wydawany z każdą wersją Flaem razem z plikiem sumy kontrolnej .sha256.

Nie. Za usługę założoną przez moduł Flaem nie wystawia żadnej faktury, nawet zerowej, i nie pobiera pieniędzy z portfela klienta. Fakturuje wyłącznie WHMCS.

WHMCS. Moduł przekazuje zawieszenie do Flaem z powodem "brak płatności". Flaem nigdy nie zawiesza takiej usługi sam.

Nie. Wchodzi z WHMCS jednorazowym linkiem. Hasło może ustawić później w ustawieniach konta jako drugie wejście, a link nie omija weryfikacji dwuetapowej, jeśli klient ją włączył.

Flaem odda pierwszą odpowiedź. Klucz idempotencji powstaje z numeru usługi w WHMCS i rodzaju akcji, więc ponowienie nie założy drugiej maszyny.

Tak. Usługi z WHMCS i usługi kupione w sklepie Flaem działają obok siebie na tych samych węzłach. Każdą rozlicza system, w którym ją kupiono.

Działają dalej. Powiązania zostają w panelu Flaem, a usługi przejmujesz na rozliczenia Flaem albo rozłączasz na ekranie mostu rozliczeniowego.

Klucz mostu ma domyślnie 600 zapytań na minutę, więcej niż zwykły klucz API, żeby nocny cron WHMCS przeszedł przez wszystkie usługi. Limit podniesiesz dla tego jednego klucza w panelu.

Podłączymy Flaem do Twojego WHMCS

Napisz, jakie produkty sprzedajesz w WHMCS i na ilu węzłach. Na prezentacji pokażemy moduł, pomożemy odwzorować katalog i policzymy licencję z cennika.