Référence API
Référence API portail
Endpoints consommés par les portails captifs ReadyZone.
Adresses de base
| Service | URL |
|---|---|
| API Core | https://core.readyzone.space |
| Checkout | https://pay.readyzone.space |
Endpoints disponibles
GET · Nom de la zone
Retourner le nom et le libellé public de la zone pour le branding du portail.
GET · Liste des forfaits
Lister les forfaits actifs de la zone.
GET · Page de paiement
Rediriger vers la page checkout ReadyZone pour un paiement standard OM/MoMo.
POST · Achat invité
Démarrer un achat invité (sans compte) et créer une transaction de paiement.
GET · Vérifier un paiement
Vérifier l'état de la transaction et synchroniser le statut local.
GET · Disponibilité d’un identifiant
Vérifier la disponibilité d'un identifiant ReadyZone avant achat.
GET · Récupérer les identifiants
Permettre la récupération des identifiants invités via le contact de notification ou le téléphone de paiement.
GET · Coordonnées de support
Récupérer les coordonnées publiques de support d’une zone.
GET · Annonces publiques
Charger les annonces visibles sur le portail captif.
GET · Publicités publiques
Charger les publicités visibles sur le portail captif.
GET · Services publics
Charger les services proposés par la zone.
POST · Analytics portail
Enregistrer les événements d’usage du portail captif.
POST · Activation d’un ticket
Valider un ticket avant la connexion hotspot.
POST · Validation d’un code promo
Valider un code promotionnel pour un forfait.
GET · Offres gratuites
Lister les offres gratuites disponibles dans une zone.
POST · Démarrer une offre gratuite
Démarrer une demande d’offre gratuite avec ou sans OTP.
POST · Vérifier une offre gratuite
Vérifier l’OTP et attribuer l’offre gratuite.
Variables injectées dans le template
Les templates du portail utilisent les variables suivantes lors de leur génération :
{{apiBaseUrl}}: URL de base de l’API Core, utilisée pour construire les appels/api/....{{companyReference}}: référence publique de la zone, utilisée dans les paramètres et chemins d’API.{{cloudBaseUrl}}: URL de base du cloud ReadyZone, utilisée notamment pour construire le lien/checkout/{planId}.
Le portail peut aussi recevoir ces valeurs via window.HOTSPOT_RUNTIME_CONFIG, window.COMPANY_API_BASE, window.COMPANY_REF et window.CLOUD_URL. Les valeurs runtime prennent priorité sur les valeurs injectées au build.
Règles de paiement
Le portail doit respecter les règles d’affichage des boutons achat.