Back to top

Clic & Surf & Smart Wifi V1 API - Documentation

Présentation

L’API Clic & Surf & Smart Wifi V1 API permet de mettre à disposition des partenaires certaines données d’usage provenant des offres Clic & Surf et Infra Smart Wifi selon des droits et autorisations définies par les administrateurs. Cette mise à disposition s’effectue aux formats JSON. L’API offre un système complet, flexible et simple d’utilisation pour la récupération des données de votre offre WiFi.

Activation de l’API

Votre API doit être activé dans votre manager https://hotspot.2isr.fr/v4/ > Statistiques & Données > Gestion de l’API

Sécurité de l’API

Votre adresse IP doit être enregistré dans votre manager https://hotspot.2isr.fr/v4/ > Statistiques & Données > Gestion de l’API

Format des requètes

Toutes les données sont transmises en UTF8

Composition des requètes

Les paramètres suivants sont obligatoire dans l’ensemble des requètes :

Nom Valeur Type Description
cle 379j4ya8gdepj8xntgsgesxnf POST/GET Valeur de votre clé API disponible sur hotspot.2isr.fr
hotspot XXX00-000 POST/GET Identifiant du hotspot

Exemple de requètes GET : https://api-hotspot.2isr.fr/v1/<fonction>/?cle=valeur_cle&hotspot=XXX00-000

Les paramètres peuvent également tous être passé par la méthode POST

Réponses HTTP

Requète correctement exécuté

Code Response Description
200 OK La requète à correctement été exécutée.
201 OK La requète à correctement été exécutée et la modification prise en compte.
204 OK La requète à correctement été exécutée mais ne retourne aucune donnée.

Requète en erreur

Code Response Description
400 Bad request La requète n’est pas correctement formée.
401 Unauthorized La requète n’est pas autorisé, votre clé n’est pas valide.
403 Forbidden L’accès à l’API n’est pas autorisé avec votre adresse IP.
404 Not found La méthode n’est pas disponible.
405 Method not allowed La méthode n’est pas autorisée.

Erreurs de l’application

Code Response Description
500 Internal server error Erreur interne, la requète est valide, mais l’API n’est pas en mesure de la traiter.
503 Service unavailable Le service API est temporairement indisponible.

Modifications récentes

  • 07/2016 : Création de l’API

  • 09/2016 : Ajout des méthodes Clic & Surf :

    • liste_users_online
    • liste_ap
    • liste_logs

  • 10/2016 : Ajout des méthodes Ruckus Wireless Infra :

    • liste_users_online_smart_wifi
    • liste_ap_smart_wifi

Méthodes Clic & Surf

Utiliser ces méthodes pour extraire les informations souhaitées de votre hotspot Clic & Surf :

liste_users_online

liste_users_online
GET/liste_users_online

Liste l’ensemble des utilisateurs en ligne sur un hotspot

Example URI

GET https://api-hotspot.2isr.fr/v1/liste_users_online
Response  200
HideShow
Headers
Content-Type: application/json
X-Request-ID: f72fc614
X-Response-Time: 120ms
Body
{
  "code": 200,
  "message": "",
  "header": {
    "date_export": "2016-09-21 17:11:49",
    "fournisseur": "2ISR",
    "API": "1",
    "remote_addr": "",
    "https": "1",
    "type_donnees": "liste_logs",
    "nb_donnees": "1",
    "time": "120"
  },
  "rows": [
    {
      "token_id": "d4d968efef2e5fc67fc2a44e4a0f39e7",
      "timestamp_in": "2016-05-21 23:52:58.052457",
      "timestamp_out": "2016-05-22 01:56:01.962058",
      "user_login": "XXXXXXXXXXXXX",
      "email": "xxxx@xxxx.xx",
      "user_ip": "XX.XX.XX.XX",
      "user_mac": "XX:XX:XX:XX:XX:XX",
      "user_agent": "Mozilla/5.0 (Linux; Android 4.2.2; GT-I9192 Build/JDQ39) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/50.0.2661.89 Mobile Safari/537.36",
      "incoming": 85694239,
      "outgoing": 10977787,
      "email_verifier": 1,
      "hotspot": "XXX00-000",
      "duree": "1542",
      "fastpass": null,
      "info_client": null,
      "autoconnect": "oui",
      "logout_reason": "4",
      "lang_sys": "fr-FR",
      "lang_portail": "fr",
      "type_auth": "ConnectorFB",
      "platform": "Defaut",
      "browser": "Defaut",
      "ismobiledevice": "Non",
      "verifie_txt": "Oui",
      "ConnectorFB": {
        "FB_ID": "XXXXXXXXXXXXXX",
        "FB_Email": "xxxx@xxxx.xx",
        "FB_LastName": "XXXX",
        "FB_FirstName": "XXXXXXX",
        "FB_Birthday": "",
        "FB_Link": "https://www.facebook.com/app_scoped_user_id/XXXXXXXXXXXXXX/",
        "FB_Sexe": "female",
        "FB_Locale": "fr_FR",
        "FB_City": "",
        "verif": 1
      }
    }
  ]
}

liste_ap

liste_ap
GET/liste_ap

Liste l’ensemble des points d’accès d’un hotspot

Example URI

GET https://api-hotspot.2isr.fr/v1/liste_ap
Response  200
HideShow
Headers
Content-Type: application/json
X-Request-ID: f72fc914
X-Response-Time: 2ms
Body
{
  "code": 200,
  "message": "",
  "header": {
    "date_export": "2016-09-21 17:11:49",
    "fournisseur": "2ISR",
    "API": "1",
    "remote_addr": "",
    "type_donnees": "liste_ap",
    "nb_donnees": "1",
    "time": "2"
  },
  "rows": [
    {
      "id": "3968",
      "sn": "XXXXXXXXXXXX",
      "mac": "XX:XX:XX:XX:XX:XX",
      "host": "CHO49-001-1",
      "nom_objet": "PARUCKUSR300",
      "ip": "XX.XX.XX.XX",
      "latitude": "0.000000",
      "longitude": "0.000000"
    }
  ]
}

liste_logs

liste_logs
GET/liste_logs

Liste et détail l’ensemble des connexions réalisées sur le hotspot

Example URI

GET https://api-hotspot.2isr.fr/v1/liste_logs
URI Parameters
HideShow
date_start
date (required) Example: d/m/Y

Date de début de la période d’export.

date_end
date (required) Example: d/m/Y

Date de fin de la période d’export.

Response  200
HideShow
Headers
Content-Type: application/json
X-Request-ID: f72fc614
X-Response-Time: 120ms
Body
{
  "code": 200,
  "message": "",
  "header": {
    "date_export": "2016-09-21 17:11:49",
    "fournisseur": "2ISR",
    "API": "1",
    "remote_addr": "",
    "type_donnees": "liste_logs",
    "nb_donnees": "1",
    "time": "120"
  },
  "rows": [
    {
      "token_id": "d4d968efef2e5fc67fc2a44e4a0f39e7",
      "timestamp_in": "2016-05-21 23:52:58.052457",
      "timestamp_out": "2016-05-22 01:56:01.962058",
      "user_login": "XXXXXXXXXXXXX",
      "email": "xxxx@xxxx.xx",
      "user_ip": "XX.XX.XX.XX",
      "user_mac": "XX:XX:XX:XX:XX:XX",
      "user_agent": "Mozilla/5.0 (Linux; Android 4.2.2; GT-I9192 Build/JDQ39) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/50.0.2661.89 Mobile Safari/537.36",
      "incoming": 85694239,
      "outgoing": 10977787,
      "email_verifier": 1,
      "hotspot": "XXX00-000",
      "duree": "1542",
      "fastpass": null,
      "info_client": null,
      "autoconnect": "oui",
      "logout_reason": "4",
      "lang_sys": "fr-FR",
      "lang_portail": "fr",
      "type_auth": "ConnectorFB",
      "platform": "Defaut",
      "browser": "Defaut",
      "ismobiledevice": "Non",
      "verifie_txt": "Oui",
      "ConnectorFB": {
        "FB_ID": "XXXXXXXXXXXXXX",
        "FB_Email": "xxxx@xxxx.xx",
        "FB_LastName": "XXXX",
        "FB_FirstName": "XXXXXXX",
        "FB_Birthday": "",
        "FB_Link": "https://www.facebook.com/app_scoped_user_id/XXXXXXXXXXXXXX/",
        "FB_Sexe": "female",
        "FB_Locale": "fr_FR",
        "FB_City": "",
        "verif": 1
      }
    }
  ]
}

Méthodes Infra Smart Wifi

Utiliser ces méthodes pour extraire les informations souhaitées de votre Infra Smart Wifi :

liste_users_online_smart_wifi

liste_users_online_smart_wifi
GET/liste_users_online_smart_wifi

Liste l’ensemble des utilisateurs en ligne sur l’infrastructure Smart Wifi Ruckus Wireless

Example URI

GET https://api-hotspot.2isr.fr/v1/liste_users_online_smart_wifi
Response  200
HideShow
Headers
Content-Type: application/json
X-Request-ID: f72fc614
X-Response-Time: 120ms
Body
{
  "code": 200,
  "message": "",
  "header": {
    "date_export": "2016-09-21 17:11:49",
    "fournisseur": "2ISR",
    "API": "1",
    "remote_addr": "",
    "type_donnees": "liste_logs",
    "nb_donnees": "1",
    "time": "120"
  },
  "rows": [
    {}
  ]
}

liste_ap_smart_wifi

liste_ap_smart_wifi
GET/liste_ap_smart_wifi

Liste l’ensemble des points d’accès d’un hotspot

Example URI

GET https://api-hotspot.2isr.fr/v1/liste_ap_smart_wifi
Response  200
HideShow
Headers
Content-Type: application/json
X-Request-ID: f72fc914
X-Response-Time: 2ms
Body
{
  "code": 200,
  "message": "",
  "header": {
    "date_export": "2016-09-21 17:11:49",
    "fournisseur": "2ISR",
    "API": "1",
    "remote_addr": "",
    "https": "1",
    "type_donnees": "liste_ap_smart_wifi",
    "nb_donnees": "1",
    "time": "2"
  },
  "rows": [
    {
      "id": "3968",
      "sn": "XXXXXXXXXXXX",
      "mac": "XX:XX:XX:XX:XX:XX",
      "host": "CHO49-001-1",
      "nom_objet": "PARUCKUSR300",
      "ip": "XX.XX.XX.XX",
      "latitude": "0.000000",
      "longitude": "0.000000"
    }
  ]
}

Generated by aglio on 27 Sep 2016