Management API

Management API

REST-API zur Entdeckung von Anlagen für grüne Energie auf der Otark-Plattform

Als Markdown anzeigen

Die Management API bietet programmatischen Zugriff auf die Otark-Plattform und ermöglicht es Ihnen, Anlagen für grüne Energie zu entdecken.

Basis-URL

https://api.otark.com/v1

Alle Anfragen müssen HTTPS verwenden. Antworten werden im JSON-Format zurückgegeben.

Authentifizierung

Alle Anfragen müssen den X-Api-Key-Header enthalten:

curl -X GET "https://api.otark.com/v1/assets" \
-H "X-Api-Key: IHR_API_KEY"

Wie die Authentifizierung plattformweit funktioniert und wo die Schlüssel der übrigen APIs entstehen, steht unter Authentifizierung.

API-Schlüssel können in Ihren Kontoeinstellungen generiert werden. Bewahren Sie Ihren Schlüssel sicher auf — er gewährt Zugriff auf Ihr Otark-Konto.

Konventionen

KonventionRegel
PaginierungQuery-Parameter page (ab 1) und limit auf Listen-Endpunkten — Paginierung
Fehler400 ungültige Anfrage · 401 fehlender oder ungültiger API-Schlüssel · 403 fehlende Berechtigung · 404 Ressource nicht gefunden · 429 Ratenlimit überschritten · 500 interner Serverfehler
Ratenbegrenzung300 Anfragen je 60-Sekunden-Fenster, für alle APIs der Plattform gleich. Jede Antwort trägt x-ratelimit-limit, x-ratelimit-remaining und x-ratelimit-reset; ist das Fenster ausgeschöpft, antwortet die API mit 429 Too Many Requests

Erste Schritte

  1. API-Schlüssel erstellen in Ihren Kontoeinstellungen.
  2. Anlagen durchsuchen mit GET /v1/assets.

Siehe Authentifizierung und Paginierung für Details zur API-Key-Verwendung und zum Paginieren von Ergebnissen.

Support

Bei Fragen oder für weitere Unterstützung erreichen Sie uns über den Support.

Zuletzt aktualisiert am