Overview

This endpoint allows you to embed a widget within an iframe in your application (or website) to provide customers with ImmoScout24 functionality for purchasing listing boosting products.
Available Products: (listing boosting products)
- Via placements: Panorama, Showcase, Premium, Top placements
- Rotation products: 3 days Rotation, 7 days Rotation
- Push to top: one time push to top

Purchase/Booking Flow:
- Via products: User clicks "Platzierung Buchen" button to start the purchase/booking flow
- Rotation products: After initial purchase, user clicks "Hochschieben buchen" for rotation booking
- Push to top: User clicks "Hochschieben für X" button in the dedicated Push To Top widget

The widget has different views depending on customer type and available offers:
Euro Customers: See the main widget view showing standard placement options.
Immopunkte Customers: See the main widget view which includes the Push To Top addition. The Push To Top section only appears for customers with available Push To Top offers.
Rotation View (Immopunkte only): After purchasing a placement product, Immopunkte customers with available rotation offers will see the rotation widget view to book rotation offers.

This endpoint is only available for partners. To become one and receive access to this endpoint, please contact us through this form.

Requirements to access the widget

• We expect three-legged OAuth flow for calling the resources.
• To access the endpoint, you need to have the S_ONTOP_OFFER_WIDGET scope in your access token. This scope is required to retrieve a ticket URL that can be embedded in an iframe.
• The real estate must be already published before a purchase can take place.

Mandatory Whitelisting

For security reasons, we expect a domain name from you to add to our allowed list. This should be the domain under which the widget will be integrated. Without this step you will not be able to render the widget.

Tip

Please see sequence diagram below for the web purchase flow that will be triggered via the widget.

Supported Methods

• Retrieve a ticket URL to embed widget

The Widget

Recommended widget size: width: 430px and height: ~905px (maximum).

The widget has a fixed width but responsive height that adjusts based on content.

See the widget views in the images below - with example prices and ranking.

The Widget Main View for Euro Customers

The Widget Main View for Immopunkte Customers

The Widget Rotation View

Sequence Diagram for Web Purchase Flow for Euro Customers

Below you will find an example sequence of how the web purchase flow can be triggered through your application. The steps depicted in the color teal are controlled by ImmoScout24 and may be subject to change. For the rest of the flow (in black) you may choose to implement it the way best suits your application. A precondition for rendering the widget to start the web purchase flow is that you use a valid ticket within your iframe.

Sequence Diagram for Offer Booking Flow for Immopunkte Customers

Below you will find an example sequence of how the booking via Immopunkte flow can be triggered through your application. The steps depicted in the color teal are controlled by ImmoScout24 and may be subject to change. For the rest of the flow (in black) you may choose to implement it the way best suits your application. A precondition for rendering the widget to start the web purchase flow is that you use a valid ticket within your iframe. And the steps in opt boxes are additional steps to purchase Rotation and Push to Top products.