Zum Hauptinhalt springen

Novasense Portal API

Die Novasense Portal API bietet programmatischen Zugriff auf Ihre Solardaten, Leistungskennzahlen und Analysen. Diese RESTful API verwendet OAuth 2.0-Authentifizierung und gibt JSON-Antworten zurück.

OpenAPI-Dokumentation​

Vollständige API-Referenz mit allen verfügbaren Endpunkten, Anfrage-/Antwort-Schemas und interaktiven Tests:

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

Erste Schritte​

API-Zugang anfordern​

API-Zugangsdaten sind nicht selbstverwaltbar. Um zu beginnen:

  1. Kontaktieren Sie den Novasense Support unter info@novasense.ch
  2. Fordern Sie API-Zugangsdaten an (Client-ID und Client-Secret)
  3. Erhalten Sie Ihre Zugangsdaten sicher vom Support-Team

Authentifizierung​

Die API verwendet den OAuth 2.0 Client Credentials Flow zur Authentifizierung. Sie müssen ein Access Token erhalten, bevor Sie API-Anfragen stellen können.

Erhalten eines Access Tokens​

Token-Endpunkt:

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

Request-Header:

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

Request-Body:

grant_type=client_credentials
client_id=YOUR_CLIENT_ID
client_secret=YOUR_CLIENT_SECRET

Beispiel mit 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"

Beispiel-Antwort:

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

Verwendung des Access Tokens​

Fügen Sie das Access Token in den Authorization-Header Ihrer API-Anfragen ein:

Authorization: Bearer YOUR_ACCESS_TOKEN

Beispiel-API-Anfrage:

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

Token-Verwaltung​

Token-Gültigkeit​

  • Access Tokens sind 5 Minuten gültig (expires_in: 300 Sekunden)
  • Keine Refresh Tokens werden bereitgestellt
  • Sie müssen ein neues Access Token anfordern, wenn das aktuelle abläuft

Best Practices​

  1. Cachen Sie Tokens und verwenden Sie sie wieder, bis sie ablaufen
  2. Fordern Sie ein neues Token an, bevor das aktuelle abläuft (z.B. 30 Sekunden vorher)
  3. Minimieren Sie Authentifizierungsanfragen, um unnötigen Overhead zu reduzieren

Nutzungsrichtlinien und Rate Limiting​

Die Novasense Portal API ist für moderate, programmatische Nutzung konzipiert.

Wichtige Hinweise​

  • API-Nutzung kann eingeschränkt werden basierend auf Anfragevolumen und -mustern
  • Rate Limits werden angewendet, um faire Nutzung und Systemstabilität zu gewährleisten
  • Spezifische Rate Limits und Nutzungsrichtlinien sind nicht öffentlich dokumentiert

Richtlinien​

Um einen kontinuierlichen API-Zugang zu gewährleisten:

  1. Cachen Sie Antworten, wo angebracht, um redundante Anfragen zu reduzieren
  2. Implementieren Sie exponentielles Backoff für Wiederholungen bei Fehlern
  3. Vermeiden Sie Polling mit hohen Frequenzen
  4. Kontaktieren Sie den Novasense Support, um Ihren spezifischen Anwendungsfall und erwartete Nutzungsmuster zu besprechen

Benötigen Sie höhere Limits?​

Wenn Ihr Anwendungsfall einen höheren API-Durchsatz oder spezifische SLAs erfordert, kontaktieren Sie bitte info@novasense.ch, um individuelle Vereinbarungen zu besprechen.

Support​

Für Fragen, Probleme oder Feature-Anfragen zur API: