BRP Connect API
API für Bilanzkreisverantwortliche zur Einsicht in Verträge, Transaktionen und Nominierungen und zur Verwaltung der Kunden
Die BRP-Connect-API ist der programmatische Zugang zu BRP Connect. Bilanzkreisverantwortliche sehen darüber Verträge, Transaktionen und Nominierungen ein und bearbeiten die Zuordnung ihrer Kunden.
Basis-URL
https://api.otark.energy/v1Alle 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"Wie die Authentifizierung plattformweit funktioniert und wo die Schlüssel der übrigen APIs entstehen, steht unter Authentifizierung.
API-Schlüssel legen Sie in BRP Connect an; jeder trägt die dort gewählten Berechtigungen (API-Schlüssel). Bewahren Sie Ihren Schlüssel sicher auf — er gewährt Zugriff auf Ihr BKV-Konto im Umfang seiner Berechtigungen.
Datenmodell
Die API ist um drei Kernressourcen organisiert, die aufeinander aufbauen, dazu kommen die Kunden des BKV:
- Verträge sind die 1-Click-PPA-Einzelverträge der Kunden, mit den Namen beider Vertragsparteien und ohne Preis. Green-SPOT-Zuschläge erzeugen keinen Vertrag.
- Transaktionen sind die Liefermengen je Geschäft und Viertelstunde. Eine Transaktion aus einem Einzelvertrag verbindet die Bilanzkreise von Verkäufer und Käufer; eine Green-SPOT-Transaktion hat immer OTARK-CLEARING als Gegenseite, die Handelsgegenseite bleibt anonym. Transaktionen sind unveränderlich; eine Korrektur durch OES erzeugt eine neue Version, die die vorherige ersetzt.
- Nominierungen sind der Saldo aller gültigen Transaktionen aktiver Kunden zwischen einem Bilanzkreis des BKV und OTARK-CLEARING je Viertelstunde. Auch Nominierungen sind versioniert.
- Kunden sind die Teilnehmer, die den BKV im Onboarding benannt haben; der BKV legt keine Kunden selbst an. Er ordnet jedem Kunden genau einen aktiven Bilanzkreis zu und aktiviert ihn. Deaktivieren kann er einen Kunden nur ohne laufende oder ausstehende Verträge. Eigene Metadaten je Kunde vergibt er frei.
Erste Schritte
- API-Schlüssel in BRP Connect erstellen.
- Verträge und Kunden erkunden mit
GET /v1/contractsundGET /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 erreichen Sie uns über den Support.
/reports/cancellation-proof GET
Den Entwertungsnachweis abrufen, die Bestätigung von OES, dass GC und HKN entwertet sind. Es gibt ihn erst nach beiden Entwertungen: Einträge entstehen, sobald ein Entwertungsantrag abgeschlossen ist; solange nichts entwertet ist, bleibt die Liste leer. Der Nachweis geht immer an den Teilnehmer, nie an den Inhaber des benannten Kontos. Dieser Endpunkt ist die API-Fassung des Reports; denselben Inhalt gibt es im GCR Portal als CSV und PDF. Über die drei Reports hinaus liefert das Register nichts — insbesondere keine Bestandsbestätigung zu einem frei gewählten Stichtag. Erforderlicher Scope: reports:read
Einführung für BKVs
Informationen für Bilanzkreisverantwortliche (BKVs), die mit OES zusammenarbeiten
Zuletzt aktualisiert am