> ## Documentation Index
> Fetch the complete documentation index at: https://docs.otark.com/llms.txt
> Use this file to discover all available pages before exploring further.

# BKV-API: Einführung

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

<h3 id="base-url">
  Basis-URL
</h3>

```
https://api.otark.energy/v1
```

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

<h3 id="authentication">
  Authentifizierung
</h3>

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

```bash theme={null}
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.

<h3 id="data-model">
  Datenmodell
</h3>

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.

<h3 id="getting-started">
  Erste Schritte
</h3>

1. **API-Schlüssel** im BKV-Portal 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`.

<Note>
  Siehe [API-Konventionen](/de/brp/api-conventions) für Details zu Paginierung, Fehlerbehandlung, Zeitstempel und Ratenbegrenzung.
</Note>

<h3 id="support">
  Support
</h3>

Bei Fragen oder für weitere Unterstützung kontaktieren Sie uns unter [support@otark.com](mailto:support@otark.com).