README

Easily access meteocontrol's VCOM-API in your laravel projects

This is a laravel package making your meteocontrol data accessible with minimal configuration.

Installation

You can install the package via composer:

composer require octomated/laravel-vcom-api

You can optionally publish the config file with:

php artisan vendor:publish --tag="laravel-vcom-api-config"

The contents of the published config file:

return [
    'url' => env('MC_VCOM_API_URL', 'https://api.meteocontrol.de'),
    'username' => env('MC_VCOM_API_USERNAME'),
    'password' => env('MC_VCOM_API_PASSWORD'),
    'api_key' => env('MC_VCOM_API_KEY'),
    'auth_mode' => env('MC_VCOM_API_AUTH_MODE', 'oauth'),
];

Install this package, set your username, password and api key in your environment file, and you're good to go.

MC_VCOM_API_USERNAME=
MC_VCOM_API_PASSWORD=
MC_VCOM_API_KEY=

Usage

// let the dependency injection take care of resolving and configuring your VCOM-API client
// __construct(VcomApi $vcomApi)
// or make use of the facade for quick access
dump(VcomApi::systems()->get());

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

octomated / laravel-vcom-api

Maintainers

Details