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.
Cette requête est utilisée pour recueillir les informations de vos mods
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/. 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. |
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. |
ask | Obligatoire | mlistall : 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 | boolean | list (liste vos sondes), data (information technique de la sonde) |
date | date | Date au format YYYYMMDD HHMMSS |
mods | array | Tableau des mod’s, détails ci-dessous |
count | int | Nombre de mod’s |
processTime | var | Durée en millisecondes pour traiter la demande |
Liste des paramètres mod’s array
Voici la liste des paramètres disponibles lors du retour de notre API.
Paramètres | Type | Définition |
---|---|---|
moduid | int | Numéro de série de votre mod |
designation | var | Désignation que vous avez attribué à votre mod |
color | var | Couleur que vous avez attribué à votre mod |
processTime | var | Durée en millisecondes pour traiter la demande |
Exemples
Test cUrl
Test cUrl -> Commande
curl -# -k -d '{"ask":"mlistall" ,"apikey":"bAnuHRn" , "account":"BVZ765843"}' -X POST https://api.production.iggo.fr/api/v1/
Test cUrl -> Réponse
{
"error": 0,
"mods": [
{
"99887706": {
"moduid": "99887706",
"designation": "Zone 1",
"capteur": "Capteur température",
"unite": "Celcius",
"color": "87B752"
}
},
{
"99887735": {
"moduid": "99887735",
"designation": "ZONE L1P1",
"capteur": "Capteur température",
"unite": "Celcius",
"color": "337AB7"
}
},
{
"99887737": {
"moduid": "99887737",
"designation": "ZONE L1P2",
"capteur": "Capteur température",
"unite": "Celcius",
"color": "337AB7"
}
},
{
"99887739": {
"moduid": "99887739",
"designation": "Zone 2",
"capteur": "Capteur température",
"unite": "Celcius",
"color": "337AB7"
}
},
{
"99887740": {
"moduid": "99887740",
"designation": "ZONE L1P3",
"capteur": "Capteur température",
"unite": "Celcius",
"color": "337AB7"
}
},
{
"99887741": {
"moduid": "99887741",
"designation": "ZONE L2P1",
"capteur": "Capteur température",
"unite": "Celcius",
"color": "337AB7"
}
},
{
"99887742": {
"moduid": "99887742",
"designation": "ZONE L2P2",
"capteur": "Capteur température",
"unite": "Celcius",
"color": "337AB7"
}
},
{
"99887743": {
"moduid": "99887743",
"designation": "ZONE L2P3",
"capteur": "Capteur température",
"unite": "Celcius",
"color": "337AB7"
}
},
{
"99887744": {
"moduid": "99887744",
"designation": "ZONE Z1P1",
"capteur": "Capteur température",
"unite": "Celcius",
"color": "337AB7"
}
},
{
"99887745": {
"moduid": "99887745",
"designation": "ZONE Z1P2",
"capteur": "Capteur température",
"unite": "Celcius",
"color": "337AB7"
}
},
{
"99887746": {
"moduid": "99887746",
"designation": "ZONE L3P1",
"capteur": "Capteur température",
"unite": "Celcius",
"color": "337AB7"
}
},
{
"99887747": {
"moduid": "99887747",
"designation": "ZONE L3P2",
"capteur": "Capteur température",
"unite": "Celcius",
"color": "337AB7"
}
},
{
"99887748": {
"moduid": "99887748",
"designation": "ZONE L3P3",
"capteur": "Capteur température",
"unite": "Celcius",
"color": "337AB7"
}
},
{
"99887749": {
"moduid": "99887749",
"designation": "ZONE L4P1",
"capteur": "Capteur température",
"unite": "Celcius",
"color": "337AB7"
}
}
],
"date": "2018/10/22 17:45:33",
"count": 14,
"processTime": -0.29882
}