Api

  2. Accueil
  4. Docs
  6. Api
  8. Sondes
  10. Acquérir les données de vos mod’s

Acquérir les données de vos mod’s

Votre compte vous donne un accès immédiat à notre API gratuite : elle vous permet d’intégrer facilement nos services à vos site web, logiciel ou application CRM en PHP, ASP, .NET, JAVA ou tout autre langage.

URL

POST https://api.production.iggo.fr/api/v1/

GET https://api.production.iggo.fr/api/v1/

Paramètres

Chaque demande d’API prend en charge les paramètres suivants :

Informations techniques

# Signification
HTTP Method Toutes les requêtes peuvent être soumises en POST.
Encodage Notre API fonctionne en UTF8. Pensez à convertir/réencoder vos données avant de nous les transmettre, si nécessaire.
Sécurité SSL Pour votre sécurité, iggo.fr gère le SSL avec https://letsencrypt.org/ ou en auto-signé. Vous pouvez donc choisir d’utiliser notre API en HTTP standard, ou en HTTPS. Il est entendu que nous vous recommandons l’utilisation de nos services en toute sécurité en utilisant nos certificats pour des transactions cryptées.

Cette requête est utilisée pour acquérir les dernières informations d'un collecteur

URL

POST https://api.production.iggo.fr/api/v1/

GET https://api.production.iggo.fr/api/v1/

Liste des paramètres

Voici la liste des paramètres disponibles pour utiliser notre API.
ATTENTION : lorsque ceux-ci ne sont pas obligatoires, c’est qu’ils ont une valeur par défaut.

Paramètres Type Définition
account Obligatoire Référence utilisateur AAA1234567. Disponible depuis votre extranet.
APIkey Obligatoire Clé API de votre compte. Disponible depuis votre extranet.
moduid Obligatoire, Array Numéro de série du ou des collecteurs à interroger
ask Obligatoire lastdata : liste les détails de vos mod’s
string Option lower : retourne la réponse en minuscule.
upper : retourne la réponse en majuscule.

Liste des paramètres retours

Voici la liste des paramètres disponibles lors du retour de notre API.

Paramètres Type Définition
error 1 erreur survenue, 0 commande traitée
date date Date au format YYYYMMDD HHMMSS
mods array Informations liées aux collecteurs ARRAY[collectors][moduid]
processTime var Durée en millisecondes pour traiter la demande

Liste des paramètres collecteurs array

Voici la liste des paramètres disponibles lors du retour de notre API.

Paramètres Type Définition
moduid var Numéro de série du mod
color var Couleur attribuée au mod
date var Date de la dernière collecte
trame json Données envoyées par le mod
designation var Désignation du mod
unite var Unité de la mesure
designation_courte var Désignation iggo du mod
alerte boolean Erreur 1 ou Erreur 0

Exemples

Test cUrl

Test cUrl -> Commande

curl -# -k -d '{"ask":"clastdata" ,"apikey":"bAnuHRn" , "account":"BVZ765843", "cuid" : ["B4E62D8BA335","B4E62D8B9E79"]}' -X POST https://api.production.iggo.fr/api/v1/

Test cUrl -> Réponse


{
  "error": 0,
  "mods": [
    {
      "99887706": {
        "moduid": "99887706",
        "color": "87B752",
        "date": "2018-10-23 14:12:14",
        "trame": "{\"multdiv\":\"d2\",\"loop\":\"2\",\"temperature\":\"21.62\",\"battery\":\"862\",\"uptime\":\"4726624\",\"nexttime\":\"2048\",\"lrssi\":\"-73\",\"rssi\":\"-86\"}",
        "designation": "Zone 1",
        "unite": "Celcius",
        "designation_courte": "Capteur température",
        "alerte": "1"
      }
    },
    {
      "99887739": {
        "moduid": "99887739",
        "color": "337AB7",
        "date": "2018-10-23 14:22:19",
        "trame": "{\"multdiv\":\"d2\",\"loop\":\"\",\"temperature\":\"23.17\",\"battery\":\"966\",\"uptime\":\"2693791\",\"nexttime\":\"2048\",\"lrssi\":\"-60\",\"rssi\":\"-87\"}",
        "designation": "Zone 2",
        "unite": "Celcius",
        "designation_courte": "Capteur température",
        "alerte": "1"
      }
    }
  ],
  "date": "2018/10/23 16:33:24",
  "count": 2,
  "processTime": 0.184398
}
Étiquettes ,