PetHub APIs support a number of endpoints that, with your feedback, we will continue to add to our library. The APIs below are what are currently in our catalog.
We've broken these up into 3 sections:
- Sniffing Around - both the most commonly used API calls for starting an interaction with a user's account and also the calls you'll need when initially registering your application with PetHub and getting a user's permission to utilize their data
- Digging Deeper - endpoints that help you dig deeper into a user's or pet's information
- Webhooks - proactively pull information as well as register to have PetHub notify you when specific events have taken place (such as tags being scanned or lost pet alerts being sent, for example)
The fun stuff:
- Sniffing Around:
- Authorizations - before a 3rd party application may interact with a PetHub user's account and data, it may first receive authorization from the PetHub user
- Persons - the end-user with the account on PetHub who has control of their own and their pet's content
- Pets - the profiles of the animals managed by the PetHub platform
- Digging Deeper:
- Activities - walking, agility, eating, playing, training, sleeping, pooping, and more. This is how you list it and add to it for a particular pet
- Foods - manufacturer, formula, type (wet? kibble? raw?), amount, timing, and special preparation instructions can be found or added to for a pet with this endpoint
- LostPets - pull a list of lost pet posters for a user, specific pet, by geo location, and more. Or, add to our list of Lost Pet posters
- Perks - view which discounts a PetHub subscriber has claimed or the entire list of Perks that could be claimed
- Species - pull the list of species supported by the PetHub platform or look-up the species for a specific pet
- Tags - ability to look-up tag information including a pet's profile information if publicly published by the pet owner
- Webhooks:
- Alerts - announcements about missing or found animals
- Notifications - tag scanning events (webhook) for a particular pet or particular tag ID
Each of these can be accessed with permission from the user whose data is being requested. In addition, the user can see which applications have been given permission to use their data which can be revoked at any time. Lastly, the user can control which of these types of resources each application is allowed to access on a read / write / update / delete basis.