DocumentationDocumentationDocumentaçãoDocumentación / Guide AdminAdmin guideGuia AdminGuía Admin
ADMIN_PLATFORM
Guide de l'administrateur plateforme (RMS)Platform administrator guide (RMS)Guia do administrador da plataforma (RMS)Guía del administrador de la plataforma (RMS)
L'admin RMS supervise l'ensemble de la plateforme : il onboarde et valide les gestionnaires, gère les forfaits, lit les KPIs consolidés multi-tenant, facture les gestionnaires et surveille la sécurité. C'est le seul rôle habilité à faire des lectures inter-tenant, et uniquement sur des données agrégées.
The RMS admin supervises the whole platform: onboarding and validating managers, managing plans, reading consolidated multi-tenant KPIs, billing managers and monitoring security. It is the only role allowed cross-tenant reads, and only on aggregated data.
O admin RMS supervisiona toda a plataforma: integra e valida os gestores, gere os planos, lê os KPIs consolidados multi-tenant, fatura os gestores e monitoriza a segurança. É o único perfil autorizado a fazer leituras inter-tenant, e apenas sobre dados agregados.
El admin RMS supervisa toda la plataforma: incorpora y valida a los gestores, gestiona los planes, consulta los KPIs consolidados multi-tenant, factura a los gestores y monitorea la seguridad. Es el único rol autorizado a realizar lecturas inter-tenant, y únicamente sobre datos agregados.
🔑AccèsAccessAcessoAcceso
Connectez-vous à l'espace Admin avec votre compte Keycloak portant le rôle ADMIN_PLATFORM (realm sikaflow, connexion PKCE via le client sikaflow-web).Sign in to the Admin space with your Keycloak account holding the ADMIN_PLATFORM role (realm sikaflow, PKCE login via the sikaflow-web client).Ligue-se ao espaço Admin com a sua conta Keycloak com o perfil ADMIN_PLATFORM (realm sikaflow, autenticação PKCE via o cliente sikaflow-web).Inicie sesión en el espacio Admin con su cuenta Keycloak que tenga el rol ADMIN_PLATFORM (realm sikaflow, inicio de sesión PKCE mediante el cliente sikaflow-web).
Onboarder et valider un gestionnaireOnboard and validate a managerIntegrar e validar um gestorIncorporar y validar un gestor
Un gestionnaire est un tenant (client B2B payant). Son cycle de vie suit un statut : trial → active → suspended / terminated, avec un statut KYC parallèle : pending → verified / rejected.
A manager is a tenant (paying B2B customer). Its lifecycle follows a status: trial → active → suspended / terminated, with a parallel KYC status: pending → verified / rejected.
Um gestor é um tenant (cliente B2B pagante). O seu ciclo de vida segue um estado: trial → active → suspended / terminated, com um estado KYC paralelo: pending → verified / rejected.
Un gestor es un tenant (cliente B2B de pago). Su ciclo de vida sigue un estado: trial → active → suspended / terminated, con un estado KYC paralelo: pending → verified / rejected.
trial→
active→
suspended→
terminated
- Réception de la demandeReceive the applicationReceção do pedidoRecepción de la solicitudLe gestionnaire s'inscrit : société, contact, email, téléphone, pays, devise par défaut. Un compte Keycloak est créé et le tenant démarre en
trial, KYC pending.The manager signs up: company, contact, email, phone, country, default currency. A Keycloak account is created and the tenant starts in trial, KYC pending.O gestor regista-se: empresa, contacto, email, telefone, país, moeda predefinida. É criada uma conta Keycloak e o tenant arranca em trial, KYC pending.El gestor se registra: empresa, contacto, email, teléfono, país, moneda predeterminada. Se crea una cuenta Keycloak y el tenant arranca en trial, KYC pending.
- Contrôle KYCKYC checkControlo KYCControl KYCVérifiez l'identité de la société et du contact (documents fournis). Marquez le KYC
verified ou rejected.Verify the company and contact identity (submitted documents). Mark KYC verified or rejected.Verifique a identidade da empresa e do contacto (documentos fornecidos). Marque o KYC como verified ou rejected.Verifique la identidad de la empresa y del contacto (documentos aportados). Marque el KYC como verified o rejected.
- Attribution du forfaitAssign the planAtribuição do planoAsignación del planAffectez un forfait (
starter, pro ou business) qui fixe les limites et la commission.Assign a plan (starter, pro or business) which sets the limits and commission.Atribua um plano (starter, pro ou business) que define os limites e a comissão.Asigne un plan (starter, pro o business) que fija los límites y la comisión.
- ActivationActivationAtivaçãoActivaciónPassez le statut à
active. Le gestionnaire peut alors créer des groupes et inviter des participants.Set the status to active. The manager can then create groups and invite participants.Passe o estado para active. O gestor pode então criar grupos e convidar participantes.Cambie el estado a active. El gestor puede entonces crear grupos e invitar participantes.
⚠️KYC obligatoireKYC requiredKYC obrigatórioKYC obligatorio
N'activez jamais un gestionnaire dont le KYC n'est pas verified : il encaisse de l'argent de tiers. Un KYC rejected doit rester bloqué en trial ou être résilié.Never activate a manager whose KYC is not verified — they collect third-party money. A rejected KYC must stay blocked in trial or be terminated.Nunca ative um gestor cujo KYC não esteja verified: ele recebe dinheiro de terceiros. Um KYC rejected deve permanecer bloqueado em trial ou ser rescindido.Nunca active un gestor cuyo KYC no esté verified: recauda dinero de terceros. Un KYC rejected debe permanecer bloqueado en trial o ser rescindido.
Forfaits & limitesPricing plans & limitsPlanos & limitesPlanes & límites
Les forfaits vivent dans la partition PLATFORM et sont gérés par l'admin. Chaque forfait définit un prix mensuel (XOF et EUR) et des plafonds (groupes, participants). La part de commission conservée par Sikaflow est fixe : 25 % de la commission du tontinier, identique sur tous les forfaits — le forfait ne fait varier que les plafonds et le support (modèle Option B, 2026-09-24).
Plans live in the PLATFORM partition and are admin-managed. Each plan defines a monthly price (XOF and EUR) and caps (groups, participants). The share Sikaflow keeps is flat: 25% of the manager commission, the same on every plan — the plan only changes the caps and support (Option B model, 2026-09-24).
Os planos vivem na partição PLATFORM e são geridos pelo admin. Cada plano define um preço mensal (XOF e EUR) e limites (grupos, participantes). A parte que a Sikaflow guarda é fixa: 25% da comissão do gestor, igual em todos os planos — o plano só altera os limites e o suporte (modelo Option B, 2026-09-24).
Los planes viven en la partición PLATFORM y los gestiona el admin. Cada plan define un precio mensual (XOF y EUR) y límites (grupos, participantes). La parte que Sikaflow conserva es fija: 25% de la comisión del gestor, igual en todos los planes — el plan solo cambia los límites y el soporte (modelo Option B, 2026-09-24).
Trois paliers de référence : starter pro business. Changer le forfait d'un gestionnaire met à jour ses limites et sa commission dès la facture du mois suivant.Three reference tiers: starter pro business. Changing a manager's plan updates their limits and commission from the following month's invoice.Três escalões de referência: starter pro business. Alterar o plano de um gestor atualiza os seus limites e a sua comissão a partir da fatura do mês seguinte.Tres niveles de referencia: starter pro business. Cambiar el plan de un gestor actualiza sus límites y su comisión desde la factura del mes siguiente.
Tableau de bord consolidé (KPIs)Consolidated dashboard (KPIs)Painel consolidado (KPIs)Panel consolidado (KPIs)
Le tableau de bord Admin agrège l'activité de tous les tenants — sans jamais exposer le détail des données d'un gestionnaire. Les indicateurs proviennent de la partition PLATFORM et d'agrégats GSI, jamais de lectures brutes par tenant.
The Admin dashboard aggregates activity across all tenants — without ever exposing a manager's raw data. Metrics come from the PLATFORM partition and GSI aggregates, never raw per-tenant reads.
O painel Admin agrega a atividade de todos os tenants — sem nunca expor o detalhe dos dados de um gestor. Os indicadores provêm da partição PLATFORM e de agregados GSI, nunca de leituras brutas por tenant.
El panel Admin agrega la actividad de todos los tenants — sin exponer nunca el detalle de los datos de un gestor. Los indicadores provienen de la partición PLATFORM y de agregados GSI, nunca de lecturas brutas por tenant.
🏢 GestionnairesManagersGestoresGestores
Total, actifs, en essai, suspendus ; répartition par forfait et par pays.Total, active, trial, suspended; breakdown by plan and country.Total, ativos, em avaliação, suspensos; distribuição por plano e por país.Total, activos, en prueba, suspendidos; distribución por plan y por país.
👥 Groupes & participantsGroups & participantsGrupos & participantesGrupos & participantes
Groupes actifs, participants, taux d'occupation par rapport aux limites des forfaits.Active groups, participants, usage against plan limits.Grupos ativos, participantes, taxa de ocupação face aos limites dos planos.Grupos activos, participantes, tasa de ocupación frente a los límites de los planes.
💸 Volume de fluxFlow volumeVolume de fluxosVolumen de flujos
Cotisations encaissées (FedaPay / Stripe / hors-ligne), décaissements, par devise.Collected contributions (FedaPay / Stripe / offline), disbursements, by currency.Contribuições recebidas (FedaPay / Stripe / offline), desembolsos, por moeda.Aportaciones cobradas (FedaPay / Stripe / offline), desembolsos, por moneda.
📈 Revenus RMSRMS revenueReceitas RMSIngresos RMS
Abonnements SaaS + commissions prélevées, MRR, impayés.SaaS subscriptions + withheld commissions, MRR, overdue.Subscrições SaaS + comissões retidas, MRR, dívidas em atraso.Suscripciones SaaS + comisiones retenidas, MRR, impagos.
Facturer les gestionnairesBilling managersFaturar os gestoresFacturar a los gestores
Chaque mois, le module de facturation génère une facture INVOICE#<yyyy-mm> par gestionnaire, composée de deux lignes : l'abonnement SaaS (selon le palier) et le relevé de commissions (somme des commissions prélevées à la source sur les cotisations du mois).
Each month, the billing module generates an INVOICE#<yyyy-mm> per manager, made of two lines: the SaaS subscription (per tier) and the commission statement (sum of commissions withheld at source on the month's contributions).
Todos os meses, o módulo de faturação gera uma fatura INVOICE#<yyyy-mm> por gestor, composta por duas linhas: a subscrição SaaS (consoante o escalão) e o extrato de comissões (soma das comissões retidas na origem sobre as contribuições do mês).
Cada mes, el módulo de facturación genera una factura INVOICE#<yyyy-mm> por gestor, compuesta por dos líneas: la suscripción SaaS (según el nivel) y el extracto de comisiones (suma de las comisiones retenidas en origen sobre las aportaciones del mes).
draft→
issued→
paid/
overdue
- Revue des brouillonsReview draftsRevisão dos rascunhosRevisión de los borradoresEn début de mois, chaque facture est en
draft : vérifiez abonnement + commissions.At month start, each invoice is draft: check subscription + commissions.No início do mês, cada fatura está em draft: verifique subscrição + comissões.A principio de mes, cada factura está en draft: verifique suscripción + comisiones.
- ÉmissionIssueEmissãoEmisiónPassez la facture en
issued ; le PDF (pdfUrl) devient disponible pour le gestionnaire.Set the invoice to issued; the PDF (pdfUrl) becomes available to the manager.Passe a fatura para issued; o PDF (pdfUrl) fica disponível para o gestor.Cambie la factura a issued; el PDF (pdfUrl) queda disponible para el gestor.
- Suivi des règlementsTrack paymentAcompanhamento dos pagamentosSeguimiento de los pagosMarquez
paid à réception ; relancez les overdue.Mark paid on receipt; chase overdue ones.Marque paid na receção; faça o seguimento das overdue.Marque paid al recibir; reclame las overdue.
💡Commission au fil de l'eauCommission accrues liveComissão em tempo realComisión al instante
La commission est prélevée à la source au moment où une cotisation passe paid (champ commissionWithheld par cotisation). La facture ne fait qu'agréger — chaque franc est traçable.Commission is withheld at source when a contribution turns paid (per-contribution commissionWithheld field). The invoice only aggregates — every franc is traceable.A comissão é retida na origem no momento em que uma contribuição passa a paid (campo commissionWithheld por contribuição). A fatura apenas agrega — cada franco é rastreável.La comisión se retiene en origen en el momento en que una aportación pasa a paid (campo commissionWithheld por aportación). La factura solo agrega — cada franco es rastreable.
Supervision de la sécuritéSecurity supervisionSupervisão da segurançaSupervisión de la seguridad
Sikaflow journalise chaque action sensible dans un log d'audit (AUDIT#<timestamp>) avec l'acteur, son rôle, l'IP et la cible. Les logs Keycloak et applicatifs sont exportables vers le SIEM Wazuh existant de RMS.
Sikaflow logs every sensitive action to an audit log (AUDIT#<timestamp>) with the actor, their role, IP and target. Keycloak and application logs are shippable to RMS's existing Wazuh SIEM.
O Sikaflow regista cada ação sensível num log de auditoria (AUDIT#<timestamp>) com o autor, o seu perfil, o IP e o alvo. Os logs Keycloak e aplicacionais são exportáveis para o SIEM Wazuh já existente da RMS.
Sikaflow registra cada acción sensible en un log de auditoría (AUDIT#<timestamp>) con el actor, su rol, la IP y el objetivo. Los logs de Keycloak y de la aplicación son exportables al SIEM Wazuh ya existente de RMS.
- Logs KeycloakKeycloak logsLogs KeycloakLogs Keycloak — connexions, échecs répétés, changements de rôle. Surveillez les tentatives d'accès inter-tenant (toujours refusées : le
tenantId vient du JWT, jamais du corps de la requête).logins, repeated failures, role changes. Watch for cross-tenant access attempts (always denied: the tenantId comes from the JWT, never the request body).acessos, falhas repetidas, alterações de perfil. Vigie as tentativas de acesso inter-tenant (sempre recusadas: o tenantId vem do JWT, nunca do corpo do pedido).inicios de sesión, fallos repetidos, cambios de rol. Vigile los intentos de acceso inter-tenant (siempre denegados: el tenantId viene del JWT, nunca del cuerpo de la petición).
- Alertes fraudeFraud alertsAlertas de fraudeAlertas de fraude — la réconciliation nocturne signale les orphelins (payé chez le prestataire mais pas en local) et les écarts de montant dans le log d'audit.the nightly reconciliation flags orphans (paid at the provider but not locally) and amount mismatches into the audit log.a reconciliação noturna sinaliza os órfãos (pago no fornecedor mas não localmente) e as divergências de montante no log de auditoria.la conciliación nocturna señala los huérfanos (pagado en el proveedor pero no localmente) y las discrepancias de importe en el log de auditoría.
- KYC — tenez à jour les statuts KYC ; un KYC qui expire ou est révoqué doit déclencher une revue.keep KYC statuses current; an expiring or revoked KYC should trigger a review.mantenha os estados KYC atualizados; um KYC que expira ou é revogado deve desencadear uma revisão.mantenga actualizados los estados KYC; un KYC que caduca o es revocado debe desencadenar una revisión.
🔒Isolation multi-tenantMulti-tenant isolationIsolamento multi-tenantAislamiento multi-tenant
La règle d'or : un gestionnaire ne voit jamais les données d'un autre. Chaque enregistrement est partitionné par TENANT#<managerId> et un test de non-régression vérifie qu'une lecture inter-tenant est impossible. Les secrets (clés FedaPay/Stripe) vivent dans AWS Secrets Manager / SSM, jamais dans le code.The golden rule: a manager never sees another manager's data. Every record is partitioned by TENANT#<managerId> and a regression test asserts cross-tenant reads are impossible. Secrets (FedaPay/Stripe keys) live in AWS Secrets Manager / SSM, never in code.A regra de ouro: um gestor nunca vê os dados de outro. Cada registo é particionado por TENANT#<managerId> e um teste de não-regressão verifica que uma leitura inter-tenant é impossível. Os segredos (chaves FedaPay/Stripe) vivem no AWS Secrets Manager / SSM, nunca no código.La regla de oro: un gestor nunca ve los datos de otro. Cada registro se particiona por TENANT#<managerId> y una prueba de no-regresión verifica que una lectura inter-tenant es imposible. Los secretos (claves FedaPay/Stripe) viven en AWS Secrets Manager / SSM, nunca en el código.
Suspendre ou résilier un compteSuspend or terminate an accountSuspender ou rescindir uma contaSuspender o rescindir una cuenta
En cas d'impayé, de fraude avérée ou à la demande du client, l'admin peut faire évoluer le statut du tenant.
In case of non-payment, confirmed fraud or at the customer's request, the admin can change the tenant status.
Em caso de dívida por liquidar, de fraude comprovada ou a pedido do cliente, o admin pode alterar o estado do tenant.
En caso de impago, de fraude comprobado o a petición del cliente, el admin puede cambiar el estado del tenant.
⚠️Avant de résilierBefore terminatingAntes de rescindirAntes de rescindir
Assurez-vous qu'aucun tour n'est ouvert avec un fonds non décaissé : les participants ont cotisé et attendent leur bénéficiaire. Clôturez proprement les groupes et libérez les décaissements dus avant de passer en terminated.Make sure no round is open with an undisbursed fund: participants have contributed and are awaiting their beneficiary. Close groups cleanly and release due disbursements before setting terminated.Certifique-se de que nenhum turno está aberto com um fundo por desembolsar: os participantes contribuíram e aguardam o seu beneficiário. Encerre corretamente os grupos e liberte os desembolsos devidos antes de passar a terminated.Asegúrese de que ninguna ronda esté abierta con un fondo sin desembolsar: los participantes han aportado y esperan a su beneficiario. Cierre correctamente los grupos y libere los desembolsos pendientes antes de pasar a terminated.