salernolabs / rescuegroups
非官方的 PHP rescuegroups.org HTTP API SDK。
Requires
- guzzlehttp/guzzle: ^6.3
Requires (Dev)
- phpunit/phpunit: ^6.4
This package is auto-updated.
Last update: 2024-09-22 05:24:56 UTC
README
非官方的 rescuegroups.org HTTP API PHP SDK。此包尚不稳定，仍在开发中。请注意，其中大部分是通过 Define 查询自动生成的。由于命名约定，“list”操作封装在“GetList”类中，因为在 PHP7 中“List”是一个保留字。
在尝试使用此库之前，请务必仔细阅读 RescueGroups.org API 规范和文档。 https://rescuegroups.org/services/adoptable-pet-data-http-json-api/
安装和设置
安装此包的最简单方法是使用 composer
composer require salernolabs/rescuegroups
之后，您可以在 API 类的构造函数中指定您的 API 密钥，或者首选方法是使用以下环境变量
仅使用公共查询
- RESCUEGROUPS_API_KEY
对于需要登录的查询，您也可以指定
- RESCUEGROUPS_USERNAME
- RESCUEGROUPS_PASSWORD
- RESCUEGROUPS_ORG_ID
您可以通过这两种方式中的任何一种实例化 API 处理器
//Use environment variables
$api = new \RescueGroups\API();
//Use specific api key
$api = new \RescueGroups\API("Your API Key")
登录
要针对 HTTP API 进行非公共/未经认证的查询，您需要登录。您可以选择指定环境变量或在登录查询中设置它们。
//Use environment variables
$login = new \RescueGroups\Request\Actions\Login();
//Use specific login credentials
$login = new \RescueGroups\Request\Actions\Login("Username", "Password", 1235);
//Then just run it with the API handler
$api->executeRequest($login);
或者，如果您已经从 Rescuegroups API 获取了有效的 token 和 tokenHash，您只需在 API 处理器上调用 ->setToken() 函数即可跳过此步骤。
$api->setToken('token', 'tokenHash');
测试
您可以通过在命令行中运行 phpunit 来运行 phpunit 测试，只需运行 phpunit 即可，但请确保您已设置 API 密钥环境变量。
phpunit
如果您在计算机上未安装它，则可以从中运行它，如果您已使用带有 dev 依赖项的 composer 安装，则位于 vendor 文件夹中。
#From the folder you have this project check out in
php vendor/phpunit/phpunit/phpunit