Inhalt
Erwägungen
Zusätzlich zu den Voraussetzungen empfehlen wir, die folgenden Schritte zu unternehmen, um erfolgreich mit unserer API zu arbeiten:
- GraphQL Client: Die Verwendung eines GraphQL-Clients wie Apollo Studio, Altair GraphQL Client oder GraphiQL beschleunigt die Entwicklung Ihrer Abfragen erheblich, da diese Tools über Introspektions- und Autovervollständigungsfunktionen verfügen. Nachdem der Autorisierungs-Header gesetzt wurde, können sie die Dokumentation automatisch von unseren Endpunkten abrufen.
- Rate Limiting: Unsere API unterliegt einem Fair-Use-basierten Rate Limiting und kann sehr häufige oder komplexe Abfragen ablehnen. Bitte strukturieren Sie Ihre Datenerfassung sinnvoll und setzen Sie bei Bedarf Cache-Layer ein.
- Änderungsmitteilungen: Unsere API – wie auch unsere App – wird mehrmals pro Woche erweitert. Bestehende Funktionen gelten als stabil (sofern sie in unserer Dokumentation nicht als Experimental oder Deprecated gekennzeichnet sind), können jedoch nach vorheriger Ankündigung innerhalb eines Monats den Status Deprecated erhalten. Veraltete Abfragen und Felder können jederzeit entfernt werden. Bitte wenden Sie sich an support@ampere.cloud, um in einen Newsletter für API-Änderungen aufgenommen zu werden.
- Benutzerrechte: Alle Anfragen an unsere API werden im Kontext des Benutzers ausgeführt, der den Schlüssel generiert hat. Wenn Sie einen API-Schlüssel eines Unternehmensadministrators verwenden, können Sie alle Funktionen ausführen, die diesem zur Verfügung stehen.
Endpoint & Autorisierung
Der Endpoint der GraphQL-API ist unter folgender Adresse verfügbar:https://api.ampere.cloud/apollo-gateway
Um sich gegenüber der API zu autorisieren, wird ein Autorisierungstoken benötigt, das im Header übergeben wird:
Authorization: Bearer <token>
Dieser Token muss von jedem Benutzer bereitgestellt werden, der sich mit der API verbinden möchte.
Wenn Sie eine grafische Benutzeroberfläche haben, die dem Benutzer ermöglicht, die Kommunikation zu konfigurieren, fordern Sie ihn auf, seinen API-Token einzugeben.
Beispielabfragen
Verfügbare Anlagen abrufen
Da ein Benutzer Mitglied in mehreren Unternehmen sein kann, ist es am sinnvollsten, alle Anlagen abzurufen, auf die er zugreifen kann, wie folgt:
Dies gibt ein Ergebnis wie folgt zurück.
Sie benötigen die zurückgegebene id der Anlage, um ihre Messwerte abzurufen.
Verfügbare Messwerte abrufen
Daten sind sowohl als Rohmesswerte (z. B. erfasste Daten aus der Anlage) als auch als Analysen (z. B. interpretierte Daten wie Eigenverbrauchsrate) verfügbar.
Sie können die verfügbaren Messwerte und Analysen abfragen, indem Sie die id der Anlage in die device-Abfrage einsetzen:
Dies liefert ein Ergebnis wie folgt:
Sie können die zurückgegebenen readingTypes
verwenden, um Werte für einen bestimmten Zeitraum abzufragen.
Messwerte und Analysen anfordern
Unter Verwendung der facilityIdund der oben ermittelten verfügbaren readingtypeskönnen Sie Daten über das readingsFeld der Anlage anfordern.
Readings
Das readings Feld erwartet ein readingInput Feld , das wie folgt aufgebaut ist:
Beispiel 1: Pac-Messwerte der Anlage für einen Tag abrufen
Ergebnis
Beispiel 2: Produzierte Energie der Anlage für einen Tag abrufen
Ergebnis
Nächste Schritte
Dank der Leistungsfähigkeit von GraphQL genügt eine einzige Abfrage an unsere API, um alle benötigten Daten in einem Schritt abzurufen. Durch die Kombination der oben genannten Bereiche können Sie beispielsweise sowohl die Energieproduktion einer Anlage als auch die Einstrahlung ihrer Sensoren in einer einzigen Abfrage anfordern.
Im Allgemeinen sind alle Funktionen unserer Software (sowohl Lese- als auch Schreibzugriffe) in unserer GraphQL-API verfügbar – mit Ausnahme einiger weniger Legacy-Anwendungsfälle (weniger als 3 % der API), die weiterhin über eine REST-basierte API laufen.
Wenn Sie Unterstützung benötigen oder eine Funktion vermissen, wenden Sie sich bitte an Ihren Ansprechpartner bei amperecloud!
Weitere Ressourcen
Weitere Hilfe benötigt?
Falls Sie weitere Unterstützung benötigen, stehen Ihnen folgende Möglichkeiten zur Verfügung:
Kontaktieren Sie den Support:
- E-Mail: Senden Sie eine E-Mail an support@amperecloud.com und geben Sie Details zu Ihrem Problem an.
- Formular ausfüllen: Füllen Sie unser Online-Support-Formular aus. Geben Sie dort bitte alle relevanten Informationen zu Ihrem Anliegen an, und unser Team wird sich schnellstmöglich bei Ihnen melden.
Teilen Sie Ihr Feedback
Falls dieser Artikel Ihre Bedürfnisse nicht erfüllt hat oder Sie Vorschläge zur Verbesserung haben, lassen Sie es uns bitte wissen, indem Sie uns Feedback geben. Ihr Input hilft uns dabei, unsere Ressourcen und unseren Support zu verbessern.