Skip to content

Third Party Integration

The HouMeerOver Third Party Integration enables municipal systems to integrate programmatically with the HouMeerOver platform for automated data retrieval and real-time notifications.

Overview

The API provides secure, municipality-scoped access to:

  • Calculation results for household energy subsidies
  • Batch and household data for integration with municipal systems
  • Real-time notifications via webhooks when calculations complete
  • Export functionality for bulk data access

All API access is restricted to your municipality's data only, ensuring data privacy and security. Optionally, IP address-based restrictions can be enabled, only allowing whitelisted IP addresses to access the API.

API Architecture

Authentication

The API uses OAuth2 for secure authentication with scope-based permissions:

  • Industry-standard security protocol
  • Municipality-specific access control
  • Granular permission management
  • Token-based authentication

Endpoints

RESTful API endpoints provide access to different data types:

  • Calculations: Access completed subsidy calculations
  • Exports: Generate and download bulk data exports (planned)

Webhooks

Real-time notifications for automated workflows:

  • Immediate notifications when calculations complete
  • Secure, signed requests to your endpoints
  • Configurable per municipality

Security Considerations

Data Protection

Municipal Data Responsibilities:

  • Secure storage of API credentials
  • Proper handling of personal data (addresses, subsidy amounts)
  • Compliance with privacy regulations
  • Audit trail maintenance

API Security Features:

  • Municipality-scoped data access
  • Encrypted communication (HTTPS/TLS)
  • Token-based authentication
  • Request signing for webhooks
  • Optional IP-based access restrictions

Development Resources

API Documentation

The complete API reference is available in the interactive Swagger documentation:

HouMeerOver API Documentation

The Swagger interface provides:

  • Complete endpoint specifications
  • Interactive request/response testing
  • Authentication examples
  • Error code references
  • Request/response schemas

Choose a section below to begin your API integration journey: