# BRP Connect API (https://docs.otark.com/de/developer/brp-connect-api)

Die BRP-Connect-API ist der programmatische Zugang zu [BRP Connect](https://docs.otark.com/de/settlement/brp-connect). Bilanzkreisverantwortliche sehen darüber Verträge, Transaktionen und Nominierungen ein und bearbeiten die Zuordnung ihrer Kunden.

### 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:

```bash
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](https://docs.otark.com/de/developer/authentication).

API-Schlüssel legen Sie in BRP Connect an; jeder trägt die dort gewählten Berechtigungen ([API-Schlüssel](https://docs.otark.com/de/settlement/brp-connect/api-keys)). 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:

<Mermaid
  chart="flowchart TB
    C[&#x22;Einzelvertrag (1-Click PPA)&#x22;] --> T[&#x22;Transaktion&#x22;]
    G[&#x22;Green-SPOT-Geschäft&#x22;] --> T
    T --> N[&#x22;Nominierung&#x22;]"
/>

* **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

1. **API-Schlüssel** in BRP Connect erstellen.
2. **Verträge und Kunden erkunden** mit `GET /v1/contracts` und `GET /v1/customers`.
3. **Transaktionen einsehen** für einen Vertrag mit `GET /v1/contracts/{contract_id}/transactions`.
4. **Nominierungen prüfen** mit `GET /v1/nominations`.

<Callout type="info">
  Siehe [API-Konventionen](https://docs.otark.com/de/developer/brp-connect-api/conventions) für Details zu Paginierung, Fehlerbehandlung, Zeitstempel und Ratenbegrenzung.
</Callout>

### Support

Bei Fragen oder für weitere Unterstützung erreichen Sie uns über den [Support](https://docs.otark.com/de/support).
