README

这是一个非官方的PHP Petfinder API SDK，它使用了可免费获取的petfinder api。在使用此SDK之前，您应该阅读以下文档中的重要内容。

Getting Started

You will need an API key and secret to access the Petfinder API, which you can obtain by registering here. You will also be asked for the domain of the web site on which your applications will run. We do not currently use this information for restricting access, but we may do so in the future to protect your security information. Developers of commercial or high-volume sites and applications should refer to the restrictions below.
Restrictions

The following usage restrictions apply to users of the API:
Total requests per day: 10,000
Records per request: 1,000
Maximum records per search: 2,000
If your usage may exceed these limits, please contact us at api-help@petfinder.com.

当您拥有API密钥和密钥时，可以使用此库。

此库是为即将推出的动物救援网站构建的，我们对目前基于PHP的宠物查找API库并不满意。目前尚未完全工作，但已接近完成。要使用此库

composer require salernolabs/petfinder

查询

以下所有示例均假设您已使用您的API密钥和密钥构建了$ configuration对象。

$configuration = new \SalernoLabs\Petfinder\Configuration();

$configuration
    ->setKey($key, $secret);

您还可以在配置对象中调整一些其他值，请参阅代码以获取更多详细信息。

auth.getToken

$request = new \SalernoLabs\Petfinder\Requests\Auth\GetToken($configuration);
$data = $request->execute();

breed.list

$request = new \SalernoLabs\Petfinder\Requests\Breed\GetList($configuration);
$data = $request
            ->setAnimal('dog')
            ->execute();

pet.find

$request = new \SalernoLabs\Petfinder\Requests\Pet\Find($configuration);
$data = $request
            ->setAnimal('dog')
            ->setBreed('shnauzer')
            ->setSize('XL')
            ->setSex('M')
            ->setLocation('12345')
            ->setAge('Young')
            ->setCount(10)
            ->setOffset($lastOffset)
            ->setOutput('full')
            ->execute();

pet.get

$request = new \SalernoLabs\Petfinder\Requests\Pet\Get($configuration);
$data = $request
            ->setId(12345)
            ->execute();

pet.getRandom

$request = new \SalernoLabs\Petfinder\Requests\Pet\GetRandom($configuration);
$data = $request
            ->setAnimal('dog')
            ->setBreed('shnauzer')
            ->setSize('XL')
            ->setSex('M')
            ->setLocation('12345')
            ->setShelterId('NJ1234')
            ->setOutput('basic')
            ->execute();

shelter.find

$request = new \SalernoLabs\Petfinder\Requests\Shelter\Find($configuration);
$data = $request
            ->setLocation('12345')
            ->setCount(10)
            ->setOffset($lastOffset)
            ->execute();

shelter.get

$request = new \SalernoLabs\Petfinder\Requests\Shelter\Get($configuration);
$data = $request
            ->setId(12345)
            ->execute();

shelter.getPets

$request = new \SalernoLabs\Petfinder\Requests\Shelter\GetPets($configuration);
$data = $request
            ->setId(12345)
            ->setCount(10)
            ->setOffset($lastOffset)
            ->execute();

shelter.listByBreed

$request = new \SalernoLabs\Petfinder\Requests\Shelter\ListByBreed($configuration);
$data = $request
            ->setAnimal('dog')
            ->setBreed('shnauzer')
            ->setCount(10)
            ->setOffset($lastOffset)
            ->execute();