Partner-API
REST-Schnittstelle für Software-Anbieter, die Propertis-Daten weiterverarbeiten oder in eigene Apps spiegeln möchten. Stand: v1 (Public Preview).
Authentifizierung
Jeder Request an /api/v1/partner/* trägt einen Bearer-Token im Authorization-Header. Token-Format: pk_<prefix12>_<secret32>. Die Benchmark-Datenprodukte unter /api/v1/*-benchmark nutzen stattdessen den Header x-api-key.
Die Vergabe erfolgt aktuell manuell durch Propertis — es gibt keine Self-Service-Erzeugung. Pro Token setzen wir Scopes (LEADS_READ, LEADS_WRITE, CONVERSIONS_WRITE, ANALYTICS_READ) und optional eine IP-Allowlist sowie ein Ablaufdatum.
Der Klartext-Token wird einmalig angezeigt — nur ein Hash landet in unserer DB (analog Stripe-Keys).
Endpoints (Auszug)
/api/v1/partner/leadsLead-Export: Clicks, die aus Ihren Tracking-Links stammen. Parameter: since (ISO-8601), limit (max. 500). Scope LEADS_READ.
/api/v1/partner/conversionsGemeldete Conversions Ihres Partner-Kontos. Scope CONVERSIONS_WRITE oder LEADS_READ.
/api/v1/partner/conversionsConversion melden. Body: clickId, externalOrderId, orderValue, reportedCommission, payload. Scope CONVERSIONS_WRITE.
/api/v1/partner/analyticsAggregierte Kennzahlen: Clicks, Conversions, bestätigte Provision, Click-to-Conversion-Rate, Tagesreihe. Scope ANALYTICS_READ.
/api/v1/partner/lead-funnelFunnel der In-App-Empfehlungs-Leads (erstellt / geklickt / konvertiert) als Aggregat. Scope ANALYTICS_READ.
/api/v1/benchmarkMarktbenchmarks als k-anonymisiertes Datenprodukt. Auth über x-api-key statt Bearer-Token.
/api/v1/energie-benchmarkRegionale Energie-Effizienz-Aggregate (Ø Endenergiebedarf, Energieklassen-Verteilung). Parameter: region, gebaeudeTyp, limit.
/api/v1/nk-benchmarkRegionale Betriebskosten je m² als Aggregat. Parameter: region, gebaeudeTyp, limit.
/api/v1/sanierung-indexRegionales Sanierungs-Potenzial als Index. Parameter: region, gebaeudeTyp, limit.
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/v2/...). Innerhalb einer Version sind Felder additiv.
Conversions melden Sie zusätzlich über den signierten Endpunkt /api/affiliate/conversion/<ihr-slug> (HMAC über Zeitstempel und Body). Vollständige Referenz mit Beispielen und OpenAPI-Spec ist in Arbeit.