Partner-API

REST-Schnittstelle für Software-Anbieter, die Propertis-Daten weiterverarbeiten oder in eigene Apps spiegeln möchten. Stand: v1 (Public Preview, ab Q3 2026 GA).

Authentifizierung

Jeder API-Request trägt einen Bearer-Token im Authorization-Header. Token-Format: pk_live_* (Production) bzw. pk_test_* (Sandbox).

Tokens werden im Mandanten-Backoffice unter Einstellungen → API erzeugt. Pro Token kannst du Scopes setzen (read:mandanten, read:dokumente, write:webhooks).

Der Klartext-Token wird einmalig angezeigt — nur ein Hash landet in unserer DB (analog Stripe-Keys).

Endpoints (Auszug)

GET

/api/partner/v1/mandanten

Liste der Mandanten, auf die der API-Key Zugriff hat. Pagination via cursor.

GET

/api/partner/v1/mandanten/{id}/properties

Properties eines Mandanten — Stammdaten, Adresse, Energie-Klasse.

GET

/api/partner/v1/mandanten/{id}/dokumente

Dokumente eines Mandanten (Belege, Verträge, Energieausweise) als pre-signed URL.

POST

/api/partner/v1/webhooks

Registriere einen Webhook-Endpoint für Events (mandant.created, document.uploaded, payment.received).

POST

/api/partner/v1/affiliate/click

Click-Tracking. Liefert ein 1×1-Pixel oder JSON je nach Accept-Header.

Rate-Limits

Default: 60 Requests pro Minute pro Token.

Bei Überschreitung: HTTP 429 mitRetry-After-Header.

Höhere Limits für Strategic-Partner — bitte über Kontakt freischalten lassen.

Versionierung & Deprecation

Major-Versionen leben mindestens 12 Monate parallel. Deprecations werden 6 Monate vorher in der API-Response perSunset-Header und im Partner-Dashboard angekündigt.

Brechende Änderungen passieren nur mit Major-Bump (/api/partner/v2/...). Innerhalb einer Version sind Felder additiv.

Vollständige Referenz mit Beispielen und OpenAPI-Spec folgt mit GA.

Sandbox-Zugang anfragen