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:

Postman

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.

curl

Sie können das folgende Snippet verwenden, um ein Property zu erstellen. Ersetzen Sie {your-api-key} durch Ihren API-Schlüssel.

curl --request POST \
  --url https://api.estatesync.com/properties \
  --header 'Content-Type: application/json' \
  --header 'authorization: Bearer {your-api-key}' \
  --data '{
    "type": "apartmentRent",
    "fields": {
      "title": "The first property",
      "address": {
        "street": "Example Street",
        "streetNumber": "1",
        "postalCode": "28197",
        "city": "Example Town",
        "publish": false
      },
      "baseRent": 250,
      "numberOfRooms": 3,
      "livingArea": 60
    }
  }'

Python

Sie können das folgende Skript verwenden, um ein Property zu erstellen. Stellen Sie sicher, dass Sie {your-api-key} durch Ihren API-Schlüssel ersetzen.

import http.client
import json

conn = http.client.HTTPSConnection("api.estatesync.com")

payload = {
    "type": "apartmentRent",
    "fields": {
        "title": "The first property",
        "address": {
            "street": "Example Street",
            "streetNumber": "42",
            "postalCode": "28197",
            "city": "Example Town",
            "publish": False
        },
        "baseRent": 250,
        "numberOfRooms": 3,
        "livingArea": 60
    }
}

headers = {
    'authorization': "Bearer {your-api-key}",
    'Content-Type': "application/json"
}

conn.request("POST", "/properties", json.dumps(payload), headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

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.