owainjones74 / puregym-api-wrapper
针对 PureGym 移动 API 的 PHP API 封装器
1.0.0
2024-10-01 01:04 UTC
Requires (Dev)
- pestphp/pest: 3.x-dev
- vlucas/phpdotenv: ^5.6@dev
README
这是一个针对 PureGym 移动 API 的 PHP 封装器。该 API 不是面向公众的,并且可能会在没有任何通知的情况下被 PureGym 开发人员更改。
对 2t6h/puregym-attendance 表示极大的敬意,他们逆向工程了 API。这个库基于他们的工作。
免责声明:这个库与 PureGym 没有任何关联。使用风险自负。
https://packagist.org.cn/packages/owainjones74/puregym-api-wrapper
安装
- 使用 composer 安装此包
composer require owainjones74/puregym-api-wrapper
- 如果需要,请添加 composer 自动加载器
require 'vendor/autoload.php';
- 使用您的电子邮件和 pin 创建一个新的 PureGymClient 实例
$client = new PureGymClient('my@email.com', '12345678');
测试
- 使用
composer install --dev
安装开发依赖项 - 在项目的根目录中创建一个
.env
文件,包含以下内容
PUREGYM_USERNAME=my@email.com # Your puregym email PUREGYM_PASSWORD=12345678 # Your puregym pin
- 运行测试
composer test
用法
require 'vendor/autoload.php'; use Owainjones74\Puregym\PureGymClient; // Pass your puregym account email and pin. This is the same email and pin you use to login to the PureGym app. $client = new PureGymClient('my@email.com', '12345678'); // Get your member $member = $client->member(); // Echo out your name echo $member->firstName . ' ' . $member->lastName;
文档
Owainjones74\Puregym\PureGymClient
与 PureGym API 交互的核心客户端。
示例
$client = new PureGymClient('your@email.com`, '12345678'); $member = $client->member(); // The member linked to this information
方法
->member(): Owainjones74\Puregym\Member
返回与创建客户端时提供的电子邮件和 pin 相关联的成员。
->allGyms(): array
返回成员可用的所有健身房数组。
->gym($id): Owainjones74\Puregym\Gym
返回具有给定 id 的健身房对象。
Owainjones74\Puregym\Member
代表在创建客户端时提供的电子邮件和 pin 相关联的成员的对象。
示例
$member = $client->member(); echo $member->firstName . ' ' . $member->lastName;
方法
->activity(): Owainjones74\Puregym\Activity
返回成员的活动对象。这是该成员的最新活动。
->homeGym(): Owainjones74\Puregym\Gym
返回成员的家中健身房对象。
Owainjones74\Puregym\Gym
代表健身房的健身房对象。
示例
$gym = $client->gym(69); echo $gym->name;
方法
->attendance(): Owainjones74\Puregym\Attendance
返回健身房的活动对象。这是该健身房当前的活动,包括健身房内的人数和健身房容量。
Owainjones74\Puregym\Activity
代表成员最近活动的活动对象。
示例
$activity = $member->activity(); echo $activity->totalVisits;
Owainjones74\Puregym\Attendance
代表健身房当前活动的活动对象。主要统计数据为当前访客数量和健身房容量。
示例
$attendance = $gym->attendance(); echo $attendance->totalPeopleInGym . '/' . $attendance->maximumCapacity;