README

注意

您需要在实际使用此包之前，在 velo-antwerpen.be 请求一个 client_id 和一个 client_secret。

安装

您可以通过 composer 安装此包

composer require earnould/laravel-velo-api

该包将自动注册自己。

您需要使用以下命令发布配置文件

php artisan vendor:publish --provider="Earnould\LaravelVeloApi\VeloServiceProvider" --tag="config"

这允许您在 .env 文件中定义客户端 ID 和密钥，如下所示

VELO_CLIENT_ID = ''
VELO_CLIENT_SECRET = ''

此包允许您连接到安特卫普 Velo API。目前只有两个来源可用 stations 和 stationsStatuses。stations 资源不言而喻。stationsStatuses 资源返回所有站点的可用性。API 需要客户端 ID 和客户端密钥来检索这些结果。

快速概述

您可以使用 Earnould\LaravelVeloApi\Facades\VeloStations 门面检索所有 Velo 站点资源。

检索所有安特卫普 Velo 站点

VeloStations::all();

返回

Collection {
  array [
    0 => Earnould\LaravelVeloApi\Station {
        [
            "id" => "036"
            "name" => "036- Bourla"
            "address" => "Schuttershofstraat n° 2"
            "addressNumber" => null
            "zipCode" => "2000"
            "districtCode" => null
            "districtName" => null
            "altitude" => null
            "location" => array:2 [
                "lat" => "51.2163878210059"
                "lon" => "4.40593043087013"
            ]
            "stationType" => "BIKE"
        ]
    }
    ... => Earnould\LaravelVeloApi\Station {...} 

请求所有 Velo 站点及其对应的状态

VeloStations::allWithStatuses();

返回

Collection {
    [
        0 => Earnould\LaravelVeloApi\Station {
            [
                "id"            => "036"
                "name"          => "036- Bourla"
                "address"       => "Schuttershofstraat n° 2"
                "addressNumber" => null
                "zipCode"       => "2000"
                "districtCode"  => null
                "districtName"  => null
                "altitude"      => null
                "location"      => [
                    "lat"   =>  "51.2163878210059",
                    "lon"   =>  "4.40593043087013"
                ]
                "stationType"  => "BIKE"
                "status"       => "OPN"
                "availability" => [
                    "bikes" =>  19,
                    "slots" =>  1
                ]
            ]
        ... => Earnould\LaravelVeloApi\Station {...}
    ]
}

注意： 状态将为 OPN（表示开放站点）和 CLS（表示关闭站点）。

文档

有任何错误？有任何建议或问题？请在 GitHub 上提交 问题 并让我们看看。

如果您发现了安全问题，请通过邮件 contact@evertarnould.be 联系，而不是使用问题跟踪器。

更新日志

请参阅 CHANGELOG 了解有关最近更改的更多信息。

测试

vendor/bin/phpunit

安全性

如果您发现任何安全相关的问题，请通过邮件 contact@evertarnould.be 联系，而不是使用问题跟踪器。

致谢

• Evert Arnould
• 所有贡献者

许可

MIT 许可证（MIT）。有关更多信息，请参阅 许可文件。