Einführung

Willkommen zur offiziellen API Dokumentation der Propstack App! Mit dieser Doku können Sie eine Menge machen.

Anwendungsfälle

Sie können diese API verwenden, um zum Beispiel:

• Homepage mit aktuellen Einheiten/Projekten darzustellen.

• Auswertungen ihrer Kontakte zu machen.

• Backups ihrer wichtigen Daten zu erstellen.

Fragen / Probleme

Wenn es Fragen oder Probleme zur API von Propstack gibt, senden Sie gerne eine E-Mail an [e-mail]. Präferierte Sprache im Entwickler-Team ist Englisch. :)

Basis URL

Alle Endpunkte haben folgende Basis-URL.

https://api.propstack.de/v1

Authentication

Um Anfragen auf die API machen zu können, braucht es einen API-Schlüssel. Jeder Account in Propstack kann nur einen Schlüssel haben. Dieser Schlüssel muss in jeder Abfrage mitgesendet werden. Dies kann durch 2 Wege passieren:

URL mit api_key als Parameter

https://api.propstack.de/v1/brokers?api_key=mein_api_key

Die erste Möglichkeit funktioniert über einen Parameter api_key in der URL.

URL mit X-API-KEY im Header

$ curl https://api.propstack.de/v1/brokers -H "X-API-KEY: mein_api_key"

Die zweite Möglichkeit nutzt einen Header X-API-KEY.