Aller au contenu principal

API du Portail Novasense

L'API du Portail Novasense fournit un accès programmatique à vos données d'actifs solaires, métriques de performance et analyses. Cette API RESTful utilise l'authentification OAuth 2.0 et retourne des réponses JSON.

Documentation OpenAPI​

Référence API complète avec tous les endpoints disponibles, schémas de requête/réponse et tests interactifs :

https://api.prd.portal.novasense.ch/v2/docs

Démarrage​

Demander l'accès à l'API​

Les identifiants d'accès à l'API ne sont pas en libre-service. Pour commencer :

  1. Contactez le Support Novasense à info@novasense.ch
  2. Demandez des identifiants d'accès API (Client ID et Client Secret)
  3. Recevez vos identifiants de manière sécurisée de l'équipe support

Authentification​

L'API utilise le flux OAuth 2.0 Client Credentials pour l'authentification. Vous devez obtenir un jeton d'accès avant de faire des requêtes API.

Obtenir un jeton d'accès​

Endpoint de jeton :

POST https://auth.prd.portal.novasense.ch/realms/novasense/protocol/openid-connect/token

En-têtes de requête :

Content-Type: application/x-www-form-urlencoded

Corps de requête :

grant_type=client_credentials
client_id=YOUR_CLIENT_ID
client_secret=YOUR_CLIENT_SECRET

Exemple avec cURL :

curl -X POST https://auth.prd.portal.novasense.ch/realms/novasense/protocol/openid-connect/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET"

Exemple de réponse :

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expires_in": 300,
  "refresh_expires_in":0,
  "token_type": "Bearer",
  "not-before-policy": 0,
  "scope": "api-external-audience profile email"
}

Utilisation du jeton d'accès​

Incluez le jeton d'accès dans l'en-tête Authorization de vos requêtes API :

Authorization: Bearer YOUR_ACCESS_TOKEN

Exemple de requête API :

curl -X GET https://api.prd.portal.novasense.ch/v2/YOUR_ENDPOINT \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Gestion des jetons​

Validité des jetons​

  • Les jetons d'accès sont valides 5 minutes (expires_in: 300 secondes)
  • Aucun jeton de rafraîchissement n'est fourni
  • Vous devez demander un nouveau jeton d'accès lorsque le jeton actuel expire

Bonnes pratiques​

  1. Mettez en cache les jetons et réutilisez-les jusqu'à leur expiration
  2. Demandez un nouveau jeton avant l'expiration du jeton actuel (par exemple, 30 secondes avant)
  3. Minimisez les requêtes d'authentification pour réduire les charges inutiles

Politique d'utilisation et limitation du débit​

L'API du Portail Novasense est conçue pour une utilisation programmatique modérée.

Notes importantes​

  • L'utilisation de l'API peut être restreinte en fonction du volume et des modèles de requêtes
  • Des limites de débit sont appliquées pour garantir une utilisation équitable et la stabilité du système
  • Les limites de débit spécifiques et les politiques d'utilisation ne sont pas documentées publiquement

Directives​

Pour garantir un accès continu à l'API :

  1. Mettez en cache les réponses lorsque cela est approprié pour réduire les requêtes redondantes
  2. Implémentez un backoff exponentiel pour les nouvelles tentatives en cas d'erreurs
  3. Évitez le polling à haute fréquence
  4. Contactez le Support Novasense pour discuter de votre cas d'utilisation spécifique et des modèles d'utilisation attendus

Besoin de limites plus élevées ?​

Si votre cas d'utilisation nécessite un débit API plus élevé ou des SLA spécifiques, veuillez contacter info@novasense.ch pour discuter d'arrangements personnalisés.

Support​

Pour les questions, problèmes ou demandes de fonctionnalités liées à l'API :