Référence API
Analytics du portail
Enregistrer un événement d’usage du portail captif.
POST /api/mikrotik/analytics/eventsAccè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
| Attribut | Type | Obligatoire | Description |
|---|---|---|---|
eventType | string | Oui | Type d’événement accepté par l’API. Voir la liste ci-dessous. |
companyReference | string | Oui | Référence publique de la zone, maximum 64 caractères. |
macAddress | string | Oui | Adresse MAC observée par le portail, maximum 64 caractères. |
portalTemplate | string | Non | Identifiant du template, maximum 64 caractères. |
page | string | Non | Page ou écran d’origine, maximum 64 caractères. |
url | string | Non | URL de la page au format URL, maximum 512 caractères. |
ipAddress | string | Non | Adresse IP du client, maximum 64 caractères. |
routerIdentity | string | Non | Identité du routeur MikroTik, maximum 128 caractères. |
hotspotServerName | string | Non | Nom du serveur hotspot, maximum 128 caractères. |
metadata | object | Non | Données complémentaires JSON. Elles ne doivent pas contenir de secrets, mots de passe ou OTP. |
Valeurs de eventType
| Valeur | Signification |
|---|---|
portal_view | Affichage initial du portail. |
buy_plan_click | Clic sur l’action d’achat d’un forfait. |
news_click | Clic sur une annonce. |
services_click | Ouverture ou clic sur la section des services. |
login_click | Tentative de connexion au portail. |
recover_credentials_click | Demande de récupération des identifiants. |
powered_by_click | Clic sur le lien ReadyZone. |
logout_click | Déconnexion du portail. |
plan_list_view | Affichage de la liste des forfaits. |
plan_detail_view | Affichage du détail d’un forfait. |
checkout_started | Ouverture du checkout ou démarrage du paiement. |
payment_method_selected | Sélection d’un moyen de paiement. |
payment_started | Initialisation d’une transaction. |
payment_success | Paiement confirmé avec succès. |
payment_failed | Paiement échoué. |
otp_requested | Demande d’envoi d’un OTP. |
otp_verified | OTP validé. |
free_offer_activated | Offre gratuite activée. |
support_contact_email_click | Clic sur le bouton email du support. |
support_contact_phone_click | Clic sur le bouton téléphone du support. |
support_contact_open | Ouverture de la fenêtre de support. |
Règles de collecte
- Le navigateur envoie
Content-Type: application/jsonetAccept: application/json. - La collecte est publique et ne doit pas être utilisée pour transmettre des credentials ou des données de paiement.
metadatadoit 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)