WILLY WIFI ZONE API Documentation

Show Public Routes Only

auth

/user/create

POST

Description: Create a new user

Accessible by:

Try it out

/login

POST

Description: Authenticate existing user

Accessible by:

Try it out

/user/auth/refresh

GET

Description: Refresh user token

Accessible by:

Try it out

config

/config/support-phone

GET Auth Required

Description: Numéro de support affiché sur le portail et les tickets imprimés

Accessible by:

Try it out

/config/routerConfig.rsc

GET

Description: Génère le script de configuration RouterOS (routerId en query)

Accessible by:

Try it out

/config/hotspot/:routerId/*

GET

Description: Sert les fichiers du hotspot avec le routerId injecté

Accessible by:

Try it out

/config/hotspot/*

GET

Description: Sert les fichiers du hotspot (sans routerId)

Accessible by:

Try it out

credit

/users/:userId/credit

GET Auth Required

Description: Get user credit amount

Accessible by:

Try it out

/users/:userId/credit

POST Auth Required

Description: Add credit to user account

Accessible by:

Try it out

/users/:userId/credit/deduct

PUT Auth Required

Description: Deduct credit from user account

Accessible by:

Try it out

/users/:userId/credit/history

GET Auth Required

Description: Get user credit transaction history

Accessible by:

Try it out

/credit-transactions

GET Auth Required

Description: Get all credit transactions with filters

Accessible by:

Try it out

/credit-transactions/:id

GET Auth Required

Description: Get transaction by ID

Accessible by:

Try it out

/credit/purchase/init

POST

Description: Initialize credit purchase via Ligdicash

Accessible by:

Try it out

/credit/purchase/gandyam-hub

POST

Description: Initialize credit purchase via Gandyam Hub

Accessible by:

Try it out

/ligdi/credit/achat

POST Auth Required

Description: Init paiement — Achat de crédit (alias)

Accessible by:

Try it out

/credit/purchase/confirm

POST

Description: Confirm credit purchase with OTP

Accessible by:

Try it out

/credit/purchase/verify

POST

Description: Verify credit purchase with token

Accessible by:

Try it out

/credit/ligdi-callback

POST

Description: Ligdicash callback for credit purchase

Accessible by:

Try it out

/credit/gandyam-hub-callback

POST

Description: Gandyam Hub callback for credit purchase

Accessible by:

Try it out

/ligdi/credit/callback

POST

Description: Callback Ligdi — Crédit (alias)

Accessible by:

Try it out

/credit/test-callback

POST

Description: Test endpoint - Simulate callback

Accessible by:

Try it out

franchise

/franchises/tickets/refresh-usage

POST Auth Required

Description: Relever immédiatement les tickets connectés (routerId optionnel)

Accessible by: Admin

Try it out

/franchises/all

GET Auth Required

Description: Liste des franchisés avec ventes et stock restant

Accessible by: Admin

Try it out

/franchises/report

GET Auth Required

Description: Bilan des ventes de tous les franchisés (from/to optionnels)

Accessible by: Admin

Try it out

/franchises

POST Auth Required

Description: Créer un franchisé

Accessible by: Admin

Try it out

/franchises/:id/report

GET Auth Required

Description: Bilan des ventes d'un franchisé (from/to optionnels)

Accessible by: Admin

Try it out

/franchises/:id/tickets

GET Auth Required

Description: Tickets d'un franchisé (etat=vendus|restants)

Accessible by: Admin

Try it out

/franchises/:id/routers

PUT Auth Required

Description: Attribuer des routeurs à un franchisé

Accessible by: Admin

Try it out

/franchises/:id

GET Auth Required

Description: Détail d'un franchisé

Accessible by: Admin

Try it out

/franchises/:id

PUT Auth Required

Description: Mettre à jour un franchisé

Accessible by: Admin

Try it out

/franchises/:id

DELETE Auth Required

Description: Supprimer un franchisé

Accessible by: Admin

Try it out

generals

/router/devices-list/all

POST Auth Required

Description:

Accessible by:

Try it out

ligdi

/ligdi/create-payment-intent

POST

Description: Créer une intention de paiement

Accessible by:

Try it out

/ligdi/payment-callback

POST

Description: Callback LIGDI pour confirmer le paiement et générer les tickets

Accessible by:

Try it out

/ligdi/verify-payment-status

POST

Description: Vérifier l'état du paiement

Accessible by:

Try it out

ligdiCash

/router/payment/init

POST

Description: Initier un achat de tickets via le service de paiement actif

Accessible by:

Try it out

/router/payment/confirm

POST

Description: Confirmer le paiement (OTP ou validation sur téléphone)

Accessible by:

Try it out

/router/payment/status/:reference

GET

Description: Statut d'un paiement (polling du portail hotspot)

Accessible by:

Try it out

/router/ligdi-cash

POST

Description:

Accessible by:

Try it out

/router/ligdi-cash/confirm-souscription

POST

Description:

Accessible by:

Try it out

/router/ligdi-cash/status/:reference

GET

Description: Statut d'un paiement (polling du portail hotspot)

Accessible by:

Try it out

/router/get_url_ligdi-cash/:reference

POST

Description:

Accessible by:

Try it out

/router/ligdi-cash/verification

POST

Description:

Accessible by:

Try it out

/ligdi-callback

POST

Description:

Accessible by:

Try it out

password_recover

/forgot-password

POST

Description: Generate reset token and send recovery link

Accessible by:

Try it out

/reset-password

POST

Description: Reset password using token

Accessible by:

Try it out

payment-service

/payment-services/all

GET Auth Required

Description: Récupérer tous les services de paiement

Accessible by:

Try it out

/payment-services/active

GET Auth Required

Description: Récupérer le service de paiement actif

Accessible by:

Try it out

/payment-services

POST Auth Required

Description: Créer un nouveau service de paiement

Accessible by:

Try it out

/payment-services/:id/activate

POST Auth Required

Description: Activer un service de paiement (désactive les autres)

Accessible by:

Try it out

/payment-services/:id/deactivate

POST Auth Required

Description: Désactiver un service de paiement

Accessible by:

Try it out

/payment-methods/active

GET

Description: Méthodes de paiement proposées au client (portail captif)

Accessible by:

Try it out

/payment-services/:serviceId/methods

GET Auth Required

Description: Récupérer les méthodes de paiement d'un service

Accessible by:

Try it out

/payment-services/:serviceId/methods

POST Auth Required

Description: Ajouter une méthode de paiement à un service

Accessible by:

Try it out

/payment-methods/:methodId/toggle

PATCH Auth Required

Description: Activer/désactiver une méthode de paiement

Accessible by:

Try it out

/payment-methods/:methodId

PUT Auth Required

Description: Mettre à jour une méthode de paiement

Accessible by:

Try it out

/payment-methods/:methodId

DELETE Auth Required

Description: Supprimer une méthode de paiement

Accessible by:

Try it out

/payment-services/:id

GET Auth Required

Description: Récupérer un service de paiement par ID

Accessible by:

Try it out

/payment-services/:id

PUT Auth Required

Description: Mettre à jour un service de paiement

Accessible by:

Try it out

/payment-services/:id

DELETE Auth Required

Description: Supprimer un service de paiement

Accessible by:

Try it out

paymentRequest

/payment-requests

POST Auth Required

Description: Créer une nouvelle demande de paiement

Accessible by:

Try it out

/payment-requests

GET Auth Required

Description: Lister les demandes de paiement (avec filtres optionnels)

Accessible by:

Try it out

/payment-requests/:id

GET Auth Required

Description: Obtenir les détails d'une demande de paiement

Accessible by:

Try it out

/payment-requests/:id/approve

PUT Auth Required

Description: Approuver une demande de paiement

Accessible by:

Try it out

/payment-requests/:id/reject

PUT Auth Required

Description: Rejeter une demande de paiement

Accessible by:

Try it out

/payment-requests/:id/mark-as-paid

PUT Auth Required

Description: Marquer une demande comme payée

Accessible by:

Try it out

/payment-requests/:id

DELETE Auth Required

Description: Supprimer une demande de paiement (seulement si PENDING)

Accessible by:

Try it out

profiles

/router/profile-list/all

GET Auth Required

Description:

Accessible by:

Try it out

/router/user-profile-list/all

GET Auth Required

Description:

Accessible by:

Try it out

/router/profile/list

POST Auth Required

Description:

Accessible by:

Try it out

/router/profile-view/:id

POST Auth Required

Description:

Accessible by:

Try it out

/router/profiles-create/create

POST Auth Required

Description:

Accessible by:

Try it out

/router/profile_update/update/:id

POST Auth Required

Description:

Accessible by:

Try it out

/router/profile/delete/:id

POST Auth Required

Description:

Accessible by:

Try it out

/router/profile/delete-all

POST Auth Required

Description:

Accessible by:

Try it out

/router/profile/resync-expiry

POST Auth Required

Description:

Accessible by:

Try it out

router

/router/add

POST Auth Required

Description: Create a router

Accessible by:

Try it out

/router/update/:id

PUT Auth Required

Description: Update router by id

Accessible by:

Try it out

/router/connect

POST Auth Required

Description: Test connection to router

Accessible by:

Try it out

/router/disconnect

POST Auth Required

Description: Disconnection the router

Accessible by:

Try it out

/router/configure

POST Auth Required

Description: Configure the router

Accessible by:

Try it out

/router/get/all

GET Auth Required

Description: Disconnection the router

Accessible by:

Try it out

/router/get-user-router/all

GET Auth Required

Description: Disconnection the router

Accessible by:

Try it out

/router/get/:id

GET Auth Required

Description: Disconnection the router

Accessible by:

Try it out

/router/delete/:id

DELETE Auth Required

Description: Disconnection the router

Accessible by:

Try it out

/router/reboot

POST Auth Required

Description: Redémarrer le routeur

Accessible by:

Try it out

/router/password-change

POST Auth Required

Description: Changer de mot de passe du routeur

Accessible by:

Try it out

/router/statut-view-update/:router_id

POST Auth Required

Description: Verifier le statut du router

Accessible by:

Try it out

/router/shutdown

POST Auth Required

Description: Arrêter le routeur (si supporté)

Accessible by:

Try it out

/router/assign-to-client

POST Auth Required

Description: Assigner un router à un client

Accessible by:

Try it out

/router/unassign-from-client

POST Auth Required

Description: Retirer un router d'un client

Accessible by:

Try it out

router-status

/router-status/update

GET Auth Required

Description: Update all routers status

Accessible by:

Try it out

soldes

/admin/:adminId/soldes

GET Auth Required

Description: Get all soldes/transactions for an admin

Accessible by:

Try it out

/admin/:adminId/soldes/:id

GET Auth Required

Description: Get a solde/transaction detail for an admin

Accessible by:

Try it out

/admin/:adminId/soldes/current

GET Auth Required

Description: Get current balance for an admin

Accessible by:

Try it out

/admin/:adminId/soldes/stats

GET Auth Required

Description: Get soldes statistics by source type and day

Accessible by:

Try it out

/admin/:adminId/soldes/ventes-sum

GET Auth Required

Description: Get sum of soldes for ticket sales

Accessible by:

Try it out

souscription

/router/suscription

POST

Description:

Accessible by:

Try it out

/router/suscription/validation

POST

Description:

Accessible by:

Try it out

/hotspot/success_redirect_yengapay

GET

Description:

Accessible by:

Try it out

souscription_mikrotik

/hotspot/souscription

GET

Description:

Accessible by:

Try it out

/hotspot/success_redirect

GET

Description:

Accessible by:

Try it out

tickets

/router/ticket-list/all

GET Auth Required

Description:

Accessible by:

Try it out

/router/user-ticket-list/all

GET Auth Required

Description:

Accessible by:

Try it out

/tickets/by-reference

GET

Description:

Accessible by:

Try it out

/router/ticket/list

POST Auth Required

Description:

Accessible by:

Try it out

/router/ticket/list-by-profile/:profile

POST Auth Required

Description:

Accessible by:

Try it out

/router/ticket/create

POST Auth Required

Description:

Accessible by:

Try it out

/router/ticket/update

POST Auth Required

Description:

Accessible by:

Try it out

/router/ticket-view/:id

POST Auth Required

Description:

Accessible by:

Try it out

/router/ticket/delete/:id

POST Auth Required

Description:

Accessible by:

Try it out

/router/ticket-all-delete/delete/:id

POST Auth Required

Description:

Accessible by:

Try it out

/router/ticket-global-delete/delete-all

POST Auth Required

Description:

Accessible by:

Try it out

/router/ticket/disable

POST Auth Required

Description:

Accessible by:

Try it out

/router/ticket/generate

POST Auth Required

Description:

Accessible by:

Try it out

/client/generate

POST Auth Required

Description: Generate tickets for a client by deducting from credit

Accessible by:

Try it out

user

/users

GET Auth Required

Description: Get all users (can filter by droitId and adminId query params)

Accessible by:

Try it out

/users/:id

GET Auth Required

Description: Get user by ID

Accessible by:

Try it out

/users/:id

PUT Auth Required

Description: Update user

Accessible by:

Try it out

/users/:id

DELETE Auth Required

Description: Delete user

Accessible by:

Try it out

/admins

GET Auth Required

Description: Get all active admins

Accessible by:

Try it out

wireguard

/wireguard/add

POST Auth Required

Description: Add a WireGuard router

Accessible by:

Try it out

/router/wireguard/script/:username

GET

Description: Get WireGuard router script

Accessible by:

Try it out

/router/:id/convert-to-wireguard

PATCH Auth Required

Description: Convert a simple router to WireGuard

Accessible by:

Try it out