BRP Connect API

API für Bilanzkreisverantwortliche zur Verwaltung von Verträgen, Transaktionen, Nominierungen und Kunden

Die Otark BKV-API bietet programmatischen Zugang zum BKV-Portal und ermöglicht es Bilanzkreisverantwortlichen Verträge zu verwalten, Transaktionen und Nominierungen einzusehen sowie Kundenzuordnungen zu bearbeiten.

Basis-URL

https://api.otark.energy/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.energy/v1/contracts" \
-H "X-Api-Key: IHR_API_KEY"

API-Schlüssel können im BKV-Portal generiert werden. Bewahren Sie Ihren Schlüssel sicher auf — er gewährt vollen Zugriff auf Ihr BKV-Konto.

Datenmodell

Die API ist um drei Kernressourcen organisiert, die eine Hierarchie bilden:

Vertrag (PPA, etc.)
 └── Transaktion (vertragliche Energiemengen zwischen Käufer und Verkäufer)
       └── Nominierung (Saldo, aggregiert nach Bilanzkreis)

Verträge repräsentieren Energievereinbarungen (z.B. PPAs) zwischen einem Verkäufer und einem Käufer. Verträge sind polymorph — das Schema variiert je nach Typ.
Transaktionen repräsentieren die vertraglichen Energiemengen, die zwischen Käufer und Verkäufer im Rahmen eines Vertrags übertragen werden sollen. Transaktionen sind unveränderlich; Korrekturen erzeugen eine neue Version, die die vorherige ersetzt.
Nominierungen sind der Netto-Saldo gültiger Transaktionen, aggregiert nach Bilanzkreis und Lieferzeitraum. Nominierungen sind ebenfalls versioniert.
Kunden repräsentieren Energieverbraucher oder -erzeuger, die einem BKV zugeordnet sind. Zwei Kunden bilden jeweils die beiden Vertragsparteien eines Vertrags. Kunden können genehmigt, abgelehnt und mit Bilanzkreis-Einstellungen konfiguriert werden.

Erste Schritte

API-Schlüssel im BKV-Portal erstellen.
Verträge und Kunden erkunden mit GET /v1/contracts und GET /v1/customers.
Transaktionen einsehen für einen Vertrag mit GET /v1/contracts/{contract_id}/transactions.
Nominierungen prüfen mit GET /v1/nominations.

Siehe API-Konventionen für Details zu Paginierung, Fehlerbehandlung, Zeitstempel und Ratenbegrenzung.

Support

Bei Fragen oder für weitere Unterstützung kontaktieren Sie uns unter support@otark.com.