README

A simple Laravel integration for the Heizreport API. This package provides a clean interface to interact with the API.

📖 This README is also available in 🇩🇪 German.

📦 Installation

Install the package via Composer:

composer require mapo-89/laravel-heizreport-api

Add your API token to your .env file:

HEIZREPORT_API_TOKEN=your-token-here

Alternatively, you can load the token dynamically (e.g., from a database). In your AppServiceProvider inside the boot() method:

use Illuminate\Support\Facades\Config;
use App\Models\Integration;

public function boot()
{
    Config::set('heizreport-api.api_token', Integration::getApiToken('Heizreport'));
}

Optionally, you can publish the config file:

php artisan vendor:publish --provider="Mapo89\LaravelHeizreportApi\HeizreportApiServiceProvider" --tag="config"

⚙️ Usage

use Mapo89\LaravelHeizreportApi\Facades\HeizreportApi;

// Example: Fetch all projects
$data = HeizreportApi::make()->projects()->all(); // customize this based on your needs

📚 Full API documentation available at: heizreport.com

✅ Testing

composer test

📒 Changelog

Please see CHANGELOG for recent changes.

🤝 Contributing

Contributions are welcome! Please see CONTRIBUTING for details.

🔐 Security

If you discover any security issues, please do not use the issue tracker. Instead, email us directly at info@postler.de.

mapo-89 / laravel-heizreport-api

Maintainers

Details