Skip to content
Fabian Mielke edited this page Aug 25, 2015 · 28 revisions

english below

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.

Berechtigung "Komplettbestand Immobilienscout24":

  • Dieser Zugang hat vorerst keine Berechtigungen.
  • Sende eine E-Mail an [email protected] mit deinem Key und deiner Idee mit der Bitte um Prüfung/Freischaltung für den Komplettbestand.

Berechtigung "Kundenwebsite / Immobilienverwaltungssoftware":

  • Fordere ein Sandbox System via Mail an [email protected] in welcher Du deinen Namen nennst und dein Projekt beschreibst.
  • Du kannst Objekte eines Anbieters anzeigen, indem die Search- oder Expose-API genutzt wird (Customer website tutorial)
  • Du kannst Objekte, Kontaktadressen und Multimediaanhäge mit der Import-API anzeigen, bearbeiten und löschen (GETALL Realestate oder DELETE Attachment)
  • Bitte verwende die Expose Kontaktanfrage wenn du im Exposé ein Kontaktformular einbauen möchtest.

Fehlende Berechtigung (403 Access Denied):

  • Sende bitte eine E-Mail an [email protected] mit deinem API Consumer Key und den API-Request, der die Fehlermeldung erzeugt hat.

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