octomated/laravel-vcom-api

使用这个由 octomated 提供的包,轻松在 laravel 项目中访问 meteocontrol 的 VCOM-API

v0.2.0-alpha 2024-04-01 16:00 UTC

This package is auto-updated.

Last update: 2024-09-08 23:29:29 UTC


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

这是一个 laravel 包,通过最小配置即可访问 meteocontrol 数据。

安装

您可以通过 composer 安装此包

composer require octomated/laravel-vcom-api

您可以可选地使用以下命令发布配置文件:

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

已发布的配置文件的内容

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'),
];

安装此包,设置您的用户名、密码和 API 密钥到您的环境文件中,然后您就可以使用了。

MC_VCOM_API_USERNAME=
MC_VCOM_API_PASSWORD=
MC_VCOM_API_KEY=

使用方法

// 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());

测试

composer test

变更日志

请参阅 CHANGELOG 了解最近更改的详细信息。

贡献

请参阅 CONTRIBUTING 了解详情。

安全漏洞

请查阅 我们的安全策略 了解如何报告安全漏洞。

鸣谢

许可协议

MIT 许可证 (MIT)。有关更多信息,请参阅 许可文件