Capfile API

Récupère la clé API active associée à votre compte.

{
  "success": true,
  "code": 200,
  "message": "Clé API",
  "data": {
    "api_key": "TamxBsK9hTjszezcSy4sdfsdfsdfqRmYUFo"
  }
}

Révoque la clé actuelle et en génère une nouvelle immédiatement.

{
  "success": true,
  "code": 200,
  "message": "Clé API renouvelée",
  "data": {
    "api_key": "anQBz1brst89eymswVCqhk29mpKqnb7n"
  }
}

Réponse JSON

{
  "success": true,
  "code": 200,
  "message": "OK",
  "data": [
    {
      "prm": "12345678901234",
      "name": "Maison principale"
    },
    {
      "prm": "98765432109876",
      "name": "Appartement voisin",
      "shared": true
    }
  ]
}

Réponse JSON (extrait, "itc" tronqué)

{
  "success": true,
  "code": 200,
  "message": "OK",
  "data": {
    "prm": "12345678901234",
    "name": "Maison principale",
    "segments": {
      "C5": {
        "segment": "C5",
        "etatContractuel": "En service",
        "etatContractuelCode": "SERVC"
      }
    },
    "itc": {
      "point": {
        "donneesGenerales": { "...": "..." },
        "situationContractuelle": { "...": "..." }
      }
    },
    "soutirage": {
      "grandeurs_physiques": {
        "EA": "Energie Active (Wh)"
      },
      "itc": { "...": "informations techniques spécifiques au flux de soutirage" }
    },
    "injection": {
      "grandeurs_physiques": {
        "EA": "Energie Active (Wh)"
      },
      "itc": { "...": "informations techniques spécifiques au flux d'injection" },
      "puissance_raccordement": 12.0
    }
  }
}

Différence vs Réel

Réponse JSON

{
  "success": true,
  "code": 200,
  "message": "OK",
  "data": {
    "head": {
      "prm": "12345678901234",
      "type": "index",
      "sens": "sou",
      "grandeur_physique": "EA",
      "start_date": "2026-03-04",
      "end_date": "2026-03-11"
    },
    "data": [
      {
        "date": "2026-03-04",
        "BASE": "11593",
        "Total": "11593",
        "cadran_BASE": "17539897",
        "cadran_Total": "17539897"
      },
      {
        "date": "2026-03-05",
        "BASE": "11021",
        "Total": "11021",
        "cadran_BASE": "17550918",
        "cadran_Total": "17550918"
      }
    ]
  }
}

Le nombre et le nom des champs (autres que date et Total) dépendent des cadrans réellement utilisés par le compteur pour la grandeur physique demandée.

Réponse JSON

{
  "success": true,
  "code": 200,
  "message": "OK",
  "data": {
    "head": {
      "prm": "04389580265458",
      "type": "loadcurve",
      "sens": "sou",
      "timezone": "Europe/Paris",
      "start_date": "2026-03-01",
      "end_date": "2026-03-11"
    },
    "data": [
      {
        "date_time": "2026-03-01T00:30:00+01:00",
        "p": 30,
        "Wh": 81
      },
      {
        "date_time": "2026-03-01T01:00:00+01:00",
        "p": 30,
        "Wh": 92
      },
      {
        "date_time": "2026-03-01T01:30:00+01:00",
        "p": 30,
        "Wh": 81
      }
    ]
  }
}

Consulte vos quotas autorisés, votre consommation actuelle et le nombre d'appels restants sur chaque période. Cet endpoint requiert l'authentification par API Key (x-api-key) et n'est pas soumis lui-même au décompte des quotas.

Réponse JSON

{
  "success": true,
  "code": 200,
  "message": "Usage et quotas",
  "data": {
    "quotas": {
      "day": 5000,
      "week": 50000,
      "month": 300000
    },
    "usage": {
      "day": 120,
      "week": 890,
      "month": 3400
    },
    "remaining": {
      "day": 4880,
      "week": 49110,
      "month": 296600
    }
  }
}

Renvoie la configuration actuelle de votre webhook.

Réponse JSON

{
  "success": true,
  "code": 200,
  "message": "Configuration du webhook",
  "data": {
    "url": "https://www.monsite.fr/capfile/webhook",
    "secret": "3f9c…",
    "ssl_verify_peer": true,
    "ssl_verify_host": true,
    "configured": true
  }
}

Enregistre ou modifie la configuration (PUT accepté). Corps JSON, tous les champs sont optionnels sauf url lors de la première configuration ; les champs absents conservent leur valeur.

{
  "url": "https://www.monsite.fr/capfile/webhook",
  "secret": "une-cle-secrete-de-16-caracteres-minimum",
  "ssl_verify_peer": true,
  "ssl_verify_host": true
}

Supprime la configuration et arrête les notifications (POST /webhook/delete accepté si votre client HTTP ne gère pas DELETE).

Provoque immédiatement un appel de votre webhook avec une notification d'exemple, pour valider votre intégration. Le corps JSON est optionnel :

{
  "prm": "12345678901234",      // défaut : votre premier compteur
  "type": "loadcurve",          // info | index | loadcurve (défaut : loadcurve)
  "start_date": "2026-10-01",   // défaut : il y a 7 jours
  "end_date": "2026-10-07"      // défaut : aujourd'hui
}

La notification envoyée est identique à une notification réelle, avec en plus le champ "test": true. La réponse décrit le résultat de l'appel :

{
  "success": true,
  "code": 200,
  "message": "Webhook appelé",
  "data": {
    "status": "OK",
    "http_code": 200,
    "duration_ms": 143,
    "response": "…corps renvoyé par votre serveur (2000 premiers caractères)…",
    "payload": { "hook": "data_updated", "prm": "12345678901234", "name": "Bureau", "type": "loadcurve", "start_date": "2026-10-01", "end_date": "2026-10-07", "test": true },
    "signature": "a3c1…"
  }
}