Aller au contenu
ReadyZone Docs
Référence API

Analytics du portail

Enregistrer un événement d’usage du portail captif.

POST /api/mikrotik/analytics/events

Accès : Public

Cas d’usage portail

Le portail envoie les événements de consultation, de paiement, d’offre gratuite et de support afin d’alimenter les analytics de la zone.

Corps de requête

{
  "eventType": "portal_view",
  "companyReference": "readyzone-center-12345",
  "macAddress": "AA:BB:CC:DD:EE:FF",
  "portalTemplate": "model-4-template-1",
  "page": "login",
  "url": "http://192.168.88.1/login",
  "metadata": {}
}

Attributs de la requête

AttributTypeObligatoireDescription
eventTypestringOuiType d’événement accepté par l’API. Voir la liste ci-dessous.
companyReferencestringOuiRéférence publique de la zone, maximum 64 caractères.
macAddressstringOuiAdresse MAC observée par le portail, maximum 64 caractères.
portalTemplatestringNonIdentifiant du template, maximum 64 caractères.
pagestringNonPage ou écran d’origine, maximum 64 caractères.
urlstringNonURL de la page au format URL, maximum 512 caractères.
ipAddressstringNonAdresse IP du client, maximum 64 caractères.
routerIdentitystringNonIdentité du routeur MikroTik, maximum 128 caractères.
hotspotServerNamestringNonNom du serveur hotspot, maximum 128 caractères.
metadataobjectNonDonnées complémentaires JSON. Elles ne doivent pas contenir de secrets, mots de passe ou OTP.

Valeurs de eventType

ValeurSignification
portal_viewAffichage initial du portail.
buy_plan_clickClic sur l’action d’achat d’un forfait.
news_clickClic sur une annonce.
services_clickOuverture ou clic sur la section des services.
login_clickTentative de connexion au portail.
recover_credentials_clickDemande de récupération des identifiants.
powered_by_clickClic sur le lien ReadyZone.
logout_clickDéconnexion du portail.
plan_list_viewAffichage de la liste des forfaits.
plan_detail_viewAffichage du détail d’un forfait.
checkout_startedOuverture du checkout ou démarrage du paiement.
payment_method_selectedSélection d’un moyen de paiement.
payment_startedInitialisation d’une transaction.
payment_successPaiement confirmé avec succès.
payment_failedPaiement échoué.
otp_requestedDemande d’envoi d’un OTP.
otp_verifiedOTP validé.
free_offer_activatedOffre gratuite activée.
support_contact_email_clickClic sur le bouton email du support.
support_contact_phone_clickClic sur le bouton téléphone du support.
support_contact_openOuverture de la fenêtre de support.

Règles de collecte

  • Le navigateur envoie Content-Type: application/json et Accept: application/json.
  • La collecte est publique et ne doit pas être utilisée pour transmettre des credentials ou des données de paiement.
  • metadata doit rester limitée aux informations utiles à l’analyse et respecter les limites de taille de l’API.
  • Un événement peut être ignoré par le portail si la référence de zone ou l’adresse MAC n’est pas disponible.

Codes de statut

  • 201 Created
  • 400 Bad Request (payload invalide)
  • 403 Forbidden (zone non autorisée)

Sur cette page