Flaem

API, webhooki, Terraform i CLI: Flaem sterowany z kodu

Klient i operator sterują Flaem z kodu: przez publiczne API z kluczami i zakresami, 44 podpisane webhooki, klienta TypeScript, Terraform i narzędzie wiersza poleceń. Asystent AI dostaje te same uprawnienia przez MCP, a WHMCS, Blesta, Paymenter i HostBill sterują serwerami przez mostek bilingowy.

  • Twój skrypt albo aplikacja
  • TSKlient TypeScript
  • Terraform
  • Wiersz poleceń
  • Asystent AI przez MCP
  • WHMCS, Blesta, Paymenter, HostBill
Klucz API
  • Zakresy uprawnień
  • Limit zapytań na minutę
  • Dozwolone adresy
  • Wpis w dzienniku użycia
Twoja instalacja Flaem

Usługi, węzły, rozliczenia i zgłoszenia

Twoja instalacja Flaem
44 rodzaje webhooków
Twoje systemy

Każda droga do API przechodzi przez te same sprawdzenia klucza, także asystent AI i system rozliczeń.

01Klucze API

Klucz API, który mówi dokładnie, co mu wolno

Klucz tworzysz w panelu i od razu decydujesz, czego dotyczy, ile zapytań na minutę może wysłać i z jakich adresów. Każde jego wywołanie trafia do dziennika, a wymiana na nowy nie przerywa integracji.

Zakresy

Konkretne uprawnienia zamiast jednego "wszystko". Zakresu obejmującego wszystko nie ma, więc szeroki klucz zawsze widać na liście.

Limit na minutę

Domyślnie 120 zapytań na minutę. Klient może go tylko obniżyć, a podnosi go operator.

Dozwolone adresy

Klucz przypinasz do najwyżej 25 adresów albo podsieci. Z innego miejsca nie zadziała.

k7m2p9qx4tbn_**********************
prefiks widoczny w dziennikusekret pokazany tylko raz

Data ważności

Po ustalonej dacie klucz sam przestaje działać.

Wymiana z zakładką

Nowy klucz przejmuje ruch, a stary działa do końca ustalonego okna, więc nowe wdrożenie nie przerywa integracji.

Dziennik użycia

Każde wywołanie z kluczem, ścieżką i wynikiem. Publiczny prefiks wystarczy, żeby wiedzieć, który klucz to był.

Sekret widać raz

Pełny klucz pojawia się tylko przy tworzeniu. Baza przechowuje wyłącznie jego skrót.

Powiadomienie o nowym kluczu

Gdy na koncie pojawi się nowy klucz API albo nowy webhook, właściciel konta dostaje powiadomienie.

02Zakresy

Zakresy uprawnień dla każdego obszaru

Klucz dostaje tylko te obszary, których potrzebuje integracja, osobno do odczytu i do zmian. Zakres nigdy nie daje więcej, niż ma właściciel klucza: klucz pracownika wsparcia z odczytem administracyjnym widzi tylko to, co widzi jego rola.

ObszarZakresCo pozwala zrobić
Kontoaccount.readProfil właściciela klucza, jego role i podsumowanie poleceń.
Katalogcatalog.readPakiety, gry, warianty, wersje i dodatki do kupienia.
Usługiresources.readLista i szczegóły usług razem z przydzielonymi portami.
Zakupresources.provisionZakup nowych usług, płatny z salda portfela.
Cykl życiaresources.lifecycleAnulowanie, zawieszanie, przywracanie i zmiana rozmiaru usług.
Zasilanie i konsolaresources.powerStart, stop, restart, komendy konsoli, reinstalacja i konfiguracja startu.
Plikiresources.files.readresources.files.writeOdczyt katalogów i plików, a przy zapisie tworzenie, zmiana i usuwanie plików.
Oprogramowanieresources.softwareInstalacja oprogramowania na usłudze i środowisk hostingu WWW.
Metrykimetrics.readProcesor, pamięć, dysk i sieć usługi.
Sieć i DNSnetwork.readnetwork.writeRekordy DNS, domeny stron i reguły zapory.
Pocztamail.readmail.writeSkrzynki i aliasy na usłudze z pocztą.
Rozliczeniabilling.readbilling.writeSaldo portfela i faktury, a przy zapisie start doładowania portfela.
Współpracownicysubusers.readsubusers.writeUprawnienia innych osób do usług i dziennik ich działań.
Zgłoszeniasupport.readsupport.writeOdczyt, otwieranie, odpowiedzi i zamykanie zgłoszeń.
Powiadomienianotifications.readPowiadomienia z panelu właściciela klucza.
Resellerreseller.readreseller.writeKlienci resellera, ich usługi i faktury, a przy zapisie ustawienia i pakiety z marżą.
Webhookiwebhooks.readwebhooks.writeAdresy odbioru, dostarczenia i ponowienia zdarzeń.
Administracjaadmin.readadmin.writeDane całej instalacji oraz zmiany węzłów i katalogu. Tylko dla właściciela z rolą administratora.
Asystent AImcp.connectOtwiera punkt MCP i nic poza nim. Każde narzędzie asystenta potrzebuje jeszcze zakresu swojej operacji.
Mostek bilingowybilling.bridgeSterowanie usługami z systemu rozliczeń. Nie łączy się z żadnym innym zakresem.
03Dokumentacja

Dokumentacja OpenAPI 3.1 i dziennik zmian API w każdej instalacji

Każda instalacja publikuje opis swojego API w standardzie OpenAPI 3.1 i stronę Deweloperzy z przykładami kodu i przewodnikami. Opis powstaje z tej samej tablicy tras co samo API, a test w kodzie nie przepuści wydania, w którym dokumentacja rozjechałaby się z rzeczywistością.

{  "openapi": "3.1.0",  "paths": {    "/api/v1/resources": { "get": { ... } },    "/api/v1/resources/{id}/power": { "post": { ... } }  }}
OpenAPI 3.1
Maszynowy opis każdej trasy, z którego wygenerujesz klienta w dowolnym języku.
Strona Deweloperzy
Przykłady kodu i przewodniki dla deweloperów Twoich klientów, w Twoim panelu.
Publicznie, bez logowania
Referencja jest dostępna pod adresem instalacji, więc deweloper zajrzy do niej przed założeniem konta.

Dziennik zmian API

Operator prowadzi go w panelu. Wpis zaczyna jako roboczy, ma rodzaj zmiany, listę punktów API, których dotyczy, i tłumaczenia na języki instalacji. Wpis o wycofaniu albo usunięciu trafia raz do każdego, kto ma aktywny klucz API, i do webhooka api.change_announced.

Wpis roboczy
Publikacja
Powiadomienie posiadaczy kluczy
  • Dodanewidoczne w dzienniku
  • Zmienionewidoczne w dzienniku
  • Wycofaneogłaszane posiadaczom kluczy
  • Usunięteogłaszane posiadaczom kluczy
  • Poprawionewidoczne w dzienniku
04Klient TypeScript

Gotowy klient TypeScript, sprawdzany przez kompilator

Klient powstaje z opisu OpenAPI instalacji. Ścieżka, metoda, parametry i treść zapytania są sprawdzane przy kompilacji, więc wywołanie punktu API, którego nie ma, po prostu się nie skompiluje.

1import { createClient } from "@flaem/client";231const flaem = createClient({4  baseUrl: "https://panel.example.com",5  apiKey: process.env.FLAEM_API_KEY!,6});782const services = await flaem.get("/api/v1/resources");93await flaem.post("/api/v1/resources/{id}/power", {10  path: { id: services[0]!["id"] as string },11  body: { action: "restart" },12});
  • Bez zależności w czasie działania, ESM z deklaracjami typów
  • Node 20 i nowszy oraz każda przeglądarka z fetch
  • Jedna klasa błędu ze stałym kodem odmowy
  • Stronicowane listy przechodzone pętlą, strona po stronie
  • AbortSignal przy każdym wywołaniu
05Webhooki

44 rodzaje webhooków, podpisanych i ponawianych

Gdy coś dzieje się z usługą, płatnością, domeną albo zgłoszeniem, Flaem wysyła zdarzenie na adres Twojego systemu. Każde jest podpisane, ponawiane, gdy odbiorca nie odpowiada, i zapisane w dzienniku dostarczeń.

Sześć prób w rosnących odstępach

Odbiorca, który na chwilę zniknął przy wdrożeniu, dostaje zdarzenie w jednej z pierwszych prób. Ten, który zniknął na dobre, przestaje dostawać zdarzenia, zanim ktoś zapomni, o co chodziło.

  1. Próba 1brak odpowiedzi
  2. po 30 s
  3. po 2 min
  4. po 5 min
  5. po 15 min
  6. po 1 godz.

Usługi

13
  • resource.provisioned
  • resource.provisioning_failed
  • resource.app_installed
  • resource.app_install_failed
  • resource.cancelled
  • resource.cancel_incomplete
  • resource.force_cancelled
  • resource.suspended
  • resource.unsuspended
  • resource.suspension_warned
  • resource.suspension_warning_withdrawn
  • resource.deletion_eligible
  • resource.deletion_scheduled

Płatności i rozliczenia

15
  • billing.payment_received
  • billing.purchase_declined
  • billing.order_undeliverable
  • billing.refund_issued
  • billing.resource_renewed
  • billing.renewal_due_soon
  • billing.renewal_past_due
  • billing.trial_ends_soon
  • billing.payment_method_declined
  • billing.payment_method_disabled
  • billing.payment_method_expiring
  • billing.community_funding_short
  • billing.reseller_sale_settled
  • billing.reseller_margin_returned
  • billing.reseller_margin_shortfall

Domeny

13
  • domain.registered
  • domain.transferred
  • domain.renewed
  • domain.expires_soon
  • domain.expired
  • domain.redemption
  • domain.released
  • domain.registration_failed
  • domain.dnssec_enabled
  • domain.dnssec_disabled
  • domain.dnssec_rolled
  • domain.host_changed
  • domain.host_removed

Zgłoszenia i API

3
  • support.ticket_answered
  • support.ticket_closed
  • api.change_announced
Podpis HMAC-SHA256
Podpis obejmuje znacznik czasu i treść, więc odbiorca rozpozna podróbkę i stare zdarzenie podane drugi raz.
Wyłączenie z podaniem powodu
Po 20 nieudanych dostarczeniach z rzędu adres zostaje wyłączony z podanym powodem, zamiast po cichu zbierać kolejkę.
Ochrona Twojej sieci
Webhook nie trafi na adres wewnętrzny ani nie pójdzie za przekierowaniem, więc nikt nie użyje go, żeby zajrzeć do Twojej sieci.
Zdarzenie testowe i dziennik
Jednym przyciskiem wyślesz zdarzenie testowe, a dziennik pokaże każdą próbę z kodem odpowiedzi.
06Asystent AI

Asystent AI w Twojej instalacji przez MCP, z 23 narzędziami

Operator podłącza Claude'a albo innego asystenta zgodnego z MCP do własnej instalacji i pyta go o węzły, usługi, klientów, faktury, zgłoszenia, alerty i nadużycia. Asystent może dokładnie tyle, ile jego klucz, a każde wywołanie trafia do dziennika audytu.

Przykładowe pytanie

Które węzły mają problem i czyje usługi na nich stoją?

  1. list_alerts
  2. list_nodes
  3. get_node_usage
  4. list_services

Każde narzędzie to zwykłe zapytanie do API z kluczem asystenta, z tym samym zakresem, limitem i wpisem w dzienniku.

Odczyt

18
  • get_platform_overview
  • list_nodes
  • get_node
  • get_node_usage
  • get_node_transfer
  • list_services
  • get_service
  • get_service_transfer
  • list_customers
  • get_customer
  • list_invoices
  • get_invoice
  • list_tickets
  • get_ticket
  • list_alerts
  • list_escalations
  • list_abuse_cases
  • get_abuse_case

Zmiany

5
  • power_service
  • suspend_service
  • unsuspend_service
  • reply_to_ticket
  • acknowledge_alert

Czego asystent nie zrobi

  • Niczego nie usunie ani nie zainstaluje od nowa
  • Nie anuluje usługi i nie ruszy pieniędzy
  • Nie zmieni węzła ani żadnych danych dostępowych
Pulpit operatora Flaem: sprzedaż i MRR, węzły na żywo i sprawy, które czekają na człowieka
Klient dowolny
Claude Code, Claude Desktop albo każdy klient MCP, który łączy się przez HTTP z własnym nagłówkiem.
Treść to dane, nie polecenia
Zgłoszenia i skargi asystent dostaje dosłownie. Do streszczania dajesz mu klucz bez zakresów zapisu.
Odcięcie jednym kliknięciem
Odwołany klucz przestaje działać przy następnym zapytaniu asystenta.
07Terraform i CLI

Terraform i narzędzie wiersza poleceń dla Twoich klientów

Klienci, którzy trzymają infrastrukturę w kodzie, opisują swoje usługi w plikach Terraform, a codzienne operacje robią z terminala i ze skryptów. Oba narzędzia działają na tych samych kluczach API, więc obowiązują te same zakresy, limity i dziennik.

Plik z opisem usług

Usługi klienta zapisane w konfiguracji Terraform, w repozytorium obok reszty jego infrastruktury.

2

terraform plan

Przed zmianą klient widzi, co powstanie, co się zmieni i co zniknie.

3

terraform apply

Zmiana idzie przez API Flaem, z kluczem i zakresami klienta.

Wiersz poleceń

Operacje na usługach z terminala i ze skryptów, na tym samym kluczu API co reszta integracji. Ten sam limit, te same dozwolone adresy i ten sam dziennik użycia.

08Mostek bilingowy

Mostek bilingowy: Twój system rozliczeń liczy pieniądze, Flaem prowadzi serwery

Jeśli zostajesz przy WHMCS, Bleście, Paymenterze albo HostBillu, moduł Flaem podpina go pod panel. System rozliczeń zostaje właścicielem klienta, pieniędzy, okresu i windykacji, a Flaem zakłada, zawiesza i zmienia serwery.

WHMCSBlestaPaymenterHostBill

Twój system rozliczeń

  • Klient i jego dane
  • Płatności i faktury
  • Okres usługi i odnowienia
  • Windykacja i decyzja o zawieszeniu

Flaem

  • Serwer, jego zasoby i węzeł
  • Panel usługi dla klienta
  • Zawieszenie, gdy system rozliczeń o nie poprosi
  • Zużycie dysku i transferu odesłane z powrotem
Akcja w systemie rozliczeńCo robi Flaem
Utworzenie usługiŁączy klienta z kontem w panelu, za pierwszym razem zakłada je z jego adresu e-mail, i stawia usługę.
Zawieszenie i przywrócenieZawiesza usługę z powodem braku płatności i przywraca ją po wpłacie.
ZakończenieKończy usługę i otwiera okno na pobranie danych, chyba że produkt mówi inaczej.
Zmiana pakietuPrzenosi usługę na nowy pakiet z wybranymi opcjami.
Logowanie do paneluWystawia jednorazowy link logowania w chwili kliknięcia, dla klienta i dla administratora.
Karta usługiPokazuje na żywo stan, pakiet i zużycie usługi.
Aktualizacja zużyciaZapisuje dysk i transfer przy usłudze, a gdy nie ma pomiaru, pomija go zamiast wpisywać zero.
Zmiana po stronie FlaemZawieszenie, przywrócenie albo anulowanie w panelu wraca do systemu rozliczeń.

Bez drugiego serwera przez pomyłkę

Każda zmiana niesie klucz z numeru usługi i rodzaju operacji, więc zadanie ponowione po przekroczeniu czasu nie postawi drugiej maszyny.

Panel nie wystawia za nie faktur

Usługa z mostka nie dostaje we Flaem faktur, odnowień ani zawieszeń za brak płatności. Tym zajmuje się Twój system.

Osobny klucz z własnym limitem

Klucz mostka ma jeden zakres, którego nie przyjmuje zwykłe API, i domyślny limit 600 zapytań na minutę.

Moduł WHMCS z każdym wydaniem

Jedno archiwum zip z sumą SHA-256, publikowane razem z wydaniem Flaem. Bez Composera i bez instalacji z Marketplace.

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

Pytania o API, webhooki i integracje

Limity, dokumentacja, asystent AI i praca z systemem rozliczeń, który już masz.

Nie. Klucz API tworzy w swoim panelu, na swoim koncie, z zakresami i limitem, które sam wybierze.

Domyślnie 120. Klient może ten limit tylko obniżyć, a podnosi go operator. Klucz mostka bilingowego ma domyślnie 600.

W każdej instalacji, publicznie: strona referencyjna i plik OpenAPI 3.1 pod adresem panelu operatora, a do tego strona Deweloperzy z przykładami i przewodnikami.

Nie. Jego narzędzia niczego nie usuwają, nie reinstalują, nie anulują, nie ruszają pieniędzy, węzłów ani danych dostępowych. Zmienić może tylko zasilanie usługi, jej zawieszenie i przywrócenie, odpowiedź na zgłoszenie i potwierdzenie alertu, i to wyłącznie z odpowiednimi zakresami.

Flaem ponawia dostarczenie do 6 razy, w odstępach od 30 sekund do godziny. Po 20 dostarczeniach z rzędu, które się nie udały, wyłącza adres i podaje powód.

Tak. Moduł mostka bilingowego zostawia WHMCS rozliczenia, a Flaem zajmuje się serwerami. Jeśli zdecydujesz się przejść w całości, import przeniesie klientów, salda i usługi.

Tak, domyślnie do trzech prób. Przy odmowie z powodu limitu zawsze, przy błędach serwera tylko dla metod, których powtórzenie jest bezpieczne. Zapisu, który mógł się już wykonać, nie powtarza.

Pokażemy API na Twojej integracji

Napisz, co dziś łączysz z panelem: billing, skrypty, monitoring albo asystenta AI. Na prezentacji pokażemy klucze, webhooki i mostek na Twoim przykładzie.