Getting Started¶
Welcome to HouMeerOver! This guide covers everything you need to know to manage energy subsidy batches and integrate with the HouMeerOver system.
Overview¶
The HouMeerOver system provides municipality-scoped functionality that allows you to:
- Manage Batches: Create, upload, and process address batches for energy subsidy calculations
- Handle CSV Data: Import address lists and export results with subsidy amounts and login codes
- Configure Integrations: Set up OAuth2 applications for API access and webhook notifications
- Monitor Progress: Track batch processing status and handle any errors that occur
Your Access and Permissions¶
You have access to the following functionality within the HouMeerOver system:
- Batches: View, create, and modify batches within your municipality
- Batch Items: View individual address entries within batches
- OAuth Applications: Create and manage API applications for system integration
- Access Tokens: Manage OAuth2 access tokens for API authentication
- Webhooks: Configure webhook settings for automated notifications
- Webhook Entries: View webhook delivery logs and status
All operations are scoped to your specific municipality - you can only access and modify data belonging to your municipality.
Getting Started¶
Quick Start Checklist¶
- Access the System: Log into the HouMeerOver administration interface
- Create Your First Batch: Follow the Batch Management guide
- Upload Addresses: Prepare and upload your CSV file with address data
- Monitor Processing: Watch the batch status as addresses are processed
- Download Results: Export the completed batch with subsidy amounts
Integration Setup¶
If you need to integrate HouMeerOver with your municipal systems:
- Set Up API Access: Follow the Third Party Integration guide
- Configure Webhooks: Set up automated notifications using Webhooks
- Test Integration: Verify your setup works correctly
Documentation Structure¶
- Managing House Lists: Complete guide to creating, uploading, and managing address batches and working with individual address entries
- OAuth2 Authentication: Setting up secure authentication for API access
- API Endpoints: Using the HouMeerOver API to retrieve calculation data and integrate with municipal systems
- Webhooks: Configuring real-time notifications for completed calculations
Need Help?¶
If you encounter issues or have questions:
- Check the individual section troubleshooting guides for common problems
- Refer to the OpenAPI documentation available in the system for detailed API specifications
- Contact your system administrator for technical support
This documentation covers all functionality available to municipality users in the HouMeerOver system.