Skip to content
fmielke edited this page Oct 15, 2014 · 28 revisions

english below

Bitte nutzt zukünftig nicht mehr die XML-Writer Dateien, wir werden sie in naher Zukunft entfernen. Ersatz bietet das Senden eines selbst erstellten XML Codes, Hinweise dazu findet ihr hier.

Um das SDK mit der ImmobilienScout24-REST-API nutzen zu können, muss man sich für die API registrieren, dabei gibt es zwei Szenarien, die mit unterschiedlichen Berechtigungen verknüpft sind. Falls du eine Fehlermeldung "403 Acccess Denied" siehst, dann fehlt eine Berechtigung. Sende dann bitte eine E-Mail an [email protected] mit deinem API Consumer Key und den API-Request, der die Fehlermeldung erzeugt hat.

Berechtigung "Komplettbestand Immobilienscout24":

  • Erlaubt eine Suche in allen veröffentlichten Objekten bei Immobilienscout24. Man bekommt aber keine Expose-Berechtigung. Diese kann über eine Mail an [email protected] beantragt werden, in der eine kurze Projektbeschreibung von Nöten ist.

Berechtigung "Kundenwebsite / Immobilienverwaltungssoftware":

  • Erlaubt eine Suche im Objektbestand eines bestimmten Anbieters oder eine Börse. Expose-Berechtigung ist enthalten. Voraussetzung ist, dass der Anbieter über oAuth deine Applikation den Zugriff auf seine Objekte erlaubt. (Diese Abfrage funktioniert nicht, wenn der Anbieter das Produkt "Basis-Account" hat).
  • Erlaubt das Auslesen, Bearbeiten und Hochladen von Objekten eines Anbieters. Für den Usecase Immobilienverwaltungssoftware erstellen wir zuerst einen Sandbox-Zugang, damit man in einer Testumgebung Objekte anlegen und veröffentlichen kann. Auch dieser Zugang kann über die genannte E-Mailadresse angefragt werden.

Dokumentation

Einführung

In der Einführung werden grundlegende Einstellungen erklärt, die für die Nutzung des SDK nötig sind. Z.b. erfahren Sie wie man sich mit der Applikation verbindet, oder man eine Applikation zertifiziert um auf seine eignen Objekte zugreifen zu können.

Listen und Regionen

Dieser Bereich zeigt Möglichkeiten auf komplette Listen zuzugreifen. Das heißt es werden die Hauptinfos zu einer bestimmten Suche (z.B. nach einer Region) zurückgeliefert.

Objekte (Exposes)

Das Kapitel Objekte zeigt wie man alle Informationen oder auch Mediendaten zu einem einzelnen Objekt (Expose) erhält.

Anbieter

Methoden um Informationen rund um den Makler auszulesen finden Sie hier.

Objekte exportieren

Wie man Objekte direkt zu ImmoblienScout24 exportiert erfahren Sie hier. Außerdem werden Methoden zum Aktivieren und Deaktivieren der Objekte erklärt.

Home (ENG)

Please don't use the xml writer files anymore, we will delete them soon. Instead of this files, you have to use a self-made XML code, hints you can find here.

To use the SDK with the ImmobilienScout24 REST API, you have to for the API register, while there are two scenarios with different privileges associated with it. If you see an error message "403 Acccess Denied", then missing a permission. Send then please send an email to [email protected] with your API Consumer Key and the API request that generated the error message.

Permission "content partner":

  • Allows a search of all objects in Immobilienscout24. But you get no Expose permission. These can be requested via an email to [email protected], in which is a short project description needed.

Permission "customer website / real estate management" :

  • Allows a search on the object stock of a particular company or stock exchange. Expose authorization is contained. This requires that the provider oAuth your application allows access to its objects. (This query will not work if the provider the product "basic account" has).
  • Allows reading, updating and creating of objects of a provider. For the use case real estate management, we first create a sandbox access so you can create and publish objects in a test environment. This approach can also be requested via the said email address.

Documentation (ENG)

[Introduction] (https://github.com/Immocaster/php-sdk/wiki/Einführung)

In the introduction, the basic settings are explained , which are necessary for the use of the SDK. E.g. learn how to connect with the application, or one certified an application to access his own objects.

Lists and Regions

This section will show how to complete access lists. This means it is the main information to be returned to a specific search (eg after a region).

Objects ( expose )

The chapter objects shows how to get all information or media data to a single object (Expose).

Provider

Methods to provide information about the broker read, click here.

Export Objects

How to export objects directly to ImmoblienScout24, click here. In addition, methods are explained for activating and deactivating the objects.

Clone this wiki locally