Come together with the global Drupal community in Rotterdam, 28 Sept – 1 Oct 2026. Sessions, contribution, connection, and Early Bird savings until 8 June.
This module provides an API Client for Immoweb.be making it easier to integrate your project with Immoweb. This module is aimed towards developers and provides no real functionality on its own other as providing a configuration form and defining all the services so you can easily call the web services.
Before you can use the API client you will need to request API credentials specifically for your project. This can be done by contacting the Immoweb team (api@immoweb.be).
Terminology
Classified(s) is the term used by Immoweb for an "advertisement" of a property/building/piece of land/...
Versions
1.0.x Integrates with version 2 of the API. This version will soon be deprecated in favour of 3.x.
2.0.x (IN DEVELOPMENT) Integrates with version 2.5 of the Immoweb API. We do encourage the use of version 3.x since it's more future proof. V2.5 Was never released by Immoweb
3.0.x (IN DEVELOPMENT) Integrates with version 3 of the API. This will become the preferred version.
Features
- Service implementing customer authentication (oauth)
- Service implementing all classified pipeline endpoints
- Automatic authentication & refresh token logic for the classified pipeline services. Meaning you don't have to manually call the authentication service before you can call the pipeline services.
- Schema validation when creating/updating a classified to check if all required values are present.
Notes
It is possible that newer versions of the API provided by Immoweb break the integration layer. Although most of the endpoints are "locked" to a specific version, not all endpoints provide a version. If this happens please ensure to log an issue and if possible provide a fix (patch or issue for) to resolve the problem.
The Immoweb API documentation contains many more endpoints. However these can only be used internally and for their own website. The only endpoints third party vendors can integrate are the customer authentication and classified pipelines.
Credits
Initial development and currently maintained by Bram Driesen.
Supporting organizations:
Initial development
Project information
- Project categories: Developer tools, E-commerce, Integrations
1 site reports using this module- Created by bramdriesen on , updated
Stable releases for this project are covered by the security advisory policy.
Look for the shield icon below.
