Zum Hauptinhalt springen

Erste Schritte

In diesem Guide erfahren Sie, wie Sie Ihr erstes Property in EstateSync erstellen.

Erstellen eines Accounts#

Um die API zu nutzen, registrieren Sie sich zun├Ąchst unter dashboard.estatesync.com. Sie m├╝ssen Ihre E-Mail verifizieren und einen Namen f├╝r den Account w├Ąhlen. Wir empfehlen, separate Accounts f├╝r die lokale Entwicklungs- und die Produktionsumgebung zu verwenden.

API-Schl├╝ssel abrufen#

Klicken Sie im Dashboard im linken Men├╝ auf "API Keys". Sie k├Ânnen den bereits vorhandenen Standardschl├╝ssel verwenden oder einen neuen Schl├╝ssel erstellen. Klicken Sie auf das Zwischenablage-Symbol, um Ihren Schl├╝ssel f├╝r die sp├Ątere Verwendung zu kopieren.

Postman einrichten#

Die meisten Interaktionen mit EstateSync erfolgen ├╝ber die Rest-API, welche in der API-Referenz dokumentiert ist. Das bedeutet, dass Sie und Ihre Anwendung HTTPS-Anfragen an EstateSync senden, um Properties, Targets, Listings und mehr zu erstellen.

Postman bietet eine bequeme M├Âglichkeit, APIs zu testen und Requests zu senden. Wir empfehlen das Tool zu nutzen, um die ersten Anfragen an EstateSync "per Hand" zu stellen, bis Sie die Funktionalit├Ąt in Ihrer App implementiert haben. Sie k├Ânnen ganz einfach einen Account erstellen und Postmans Web- oder Desktop-App verwenden. Alternativ k├Ânnen Sie auch curl verwenden, um Anfragen per Kommandozeile zu stellen oder direkt in die Implementation ├╝bergehen (siehe n├Ąchster Schritt).

Wenn Sie unsere OpenAPI-Spezifikation innerhalb von Postman nutzen, k├Ânnen Sie zus├Ątzlich Zeit sparen. Besuchen Sie einfach die API-Referenz und laden Sie die OpenAPI-Spezifikation unter "Download" herunter. Diese Datei enth├Ąlt alle m├Âglichen API-Anfragen. Klicken Sie in Postman unter "Collections" auf "Import" und legen Sie die heruntergeladene OpenAPI-Spezifikationsdatei im sich ├Âffnenden Dialog ab. Stellen Sie sicher, dass die Checkbox "Generate collection from imported APIs" aktiviert ist. Nach dem Best├Ątigen sollte eine EstateSync-Collection im Bereich "Collections" erscheinen.

Den ersten Request senden#

Wenn Sie Anfragen an EstateSync stellen, m├╝ssen Sie den API-Schl├╝ssel Ihres Accounts angeben. Dieser Schl├╝ssel wird f├╝r die Authentifizierung und Identifizierung verwendet.

EstateSync verwendet Bearer-Authentication ÔÇö das bedeutet, dass Sie den API-Schl├╝ssel mit jedem Request im Authorization-Header senden m├╝ssen. Der Wert des Headers muss das Format Bearer {API-Schl├╝ssel} haben.

Nachfolgend finden Sie die Anweisungen f├╝r den ersten Request ÔÇö je nach der von Ihnen gew├Ąhlten Technologie:

Klicken Sie in der importierten "EstateSync"-Collection unter "Properties" auf "Create a property". In der Anfrage sind die meisten erforderlichen Daten bereits f├╝r Sie ausgef├╝llt. F├╝gen Sie noch Ihren API-Schl├╝ssel unter dem Reiter "Authorization" in den Input "Token" ein. Sie k├Ânnen auch den Payload der Anfrage unter dem Reiter "Body" einsehen.

Klicken Sie auf "Send", um den Request an EstateSync zu senden und das Property zu erstellen.

Pr├╝fen Sie die erfolgreiche Erstellung des Properties#

Wenn Sie eine "201"-Antwort erhalten haben, wurde das Property erfolgreich erstellt. Sie k├Ânnen nun den Abschnitt "Properties" im Dashboard ├╝berpr├╝fen, wo das neue Property erscheinen sollte.

Sie k├Ânnen auch eine GET-Anfrage stellen, um alle Properties Ihres Accounts aufzulisten. Nutzen Sie einfach die Anfrage "List all properties" in Ihrer Postman-Collection oder werfen Sie einen Blick in die API-Referenz.

Sie haben nun erfolgreich Ihr erstes Property erstellt. Als N├Ąchstes k├Ânnen Sie ein Target und ein Listing erstellen, um die Immobilie auf einem Portal zu ver├Âffentlichen.