PetStore API Overview

This is a classic PetStore API, designed here to showcase a pretty standard set of RESTful capabilities, but with some rather sophisticated goings on under the covers. If you have an admin license for this API you'll see quite a bit more, and be able to do quite a bit more than the rest of us mere mortals.

The API is secured using a simple AppId/Secret combination supplied in an http header. For details on how to set that up you can visit our online docs page.

The fundamental objects this API deals with are pets. The JSON representation for a pet is easiest seen as an example:

    {
            "category": {
                "id": 200,
                "name": "Dog"
            },
            "name": "Fido",
            "photoUrls": [
            ],
            "tags": [
                {
                    "id": 102,
                    "name": "mammal"
                },
                {
                    "id": 103,
                    "name": "dog"
                }
            ],
            "status": "available",
            "id": "102"
        }

The API includes methods for managing the Pet data, if you are an admin you'll see information on these methods below. Users are welcome to search the PetStore by tags, and view Pets by Id.

API Methods