Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Please use the following documentation as a guide for your integration.

Developer Assistance

If you find yourself getting stuck at any point while trying to implement the api, email us at dev-support@pinogy.com.

Pinogy API

This first step to using Pinogy’s API is to be able to log in.  Sample implementations are available for:

...

In addition, you will need to obtain the api host, access key, secret key, and password for each client.

Common Parameters

Almost all resources can be called with the following parameters:

  • order_by: This will return the results sorted by the column you specify.

  • limit: Limit the number of results. If you do not send a limit parameter the default limit is 100 records. The max limit is 1000 records (if you put limit=1001 or more, it will still return 1000 records so this is discouraged).

  • offset: Get more results. You can send the offset parameter to start at a set record count. If you do not send an offset parameter the default is 0 for the first record.


Resources

The list of available resources and parameters is available below

Pets

GET /api/pets – gets all pets
GET /api/pets/{pet_id} – gets a specific pet

...

Code Block
GET /api/pet_breeds/-137

{
    "aliases": [
        "Rott",
        "Rottie"
    ],
    "badges": [
        {
            "deleted": false,
            "file": {
                "basename": "badge-guard-dog",
                "checksum": [
                    20,
...
                    95
                ],
                "content_type": {
                    "extensions": [
                        "png"
                    ],
                    "id": 16,
                    "name": "image/png"
                },
                "content_type_id": 16,
                "description": "Guard Dog Badge",
                "extension": "png",
                "id": -552,
                "stored_at": "2019-02-20T06:54:04.602865-05:00"
            },
            "id": -216,
            "name": "Guard Dog"
        },
        {
            "deleted": false,
            "file": {
                "basename": "badge-akc-registrable",
                "checksum": [
                    254,
...
                    185
                ],
                "content_type": {
                    "extensions": [
                        "png"
                    ],
                    "id": 16,
                    "name": "image/png"
                },
                "content_type_id": 16,
                "description": "AKC Dog Badge",
                "extension": "png",
                "id": -555,
                "stored_at": "2019-02-20T06:54:04.224467-05:00"
            },
            "id": -217,
            "name": "AKC Registrable"
        }
    ],
    "custom_fields": {
        "Height": "[36287,61235)",
        "Weight": "[559,686)"
    },
    "deleted": false,
    "description": "The Rottweiler is a robust working breed of great strength descended from the mastiffs of the Roman legions. A gentle playmate and protector within the family circle, the Rottie observes the outside world with a self-assured aloofness.",
    "display_behavior": "Only if Available",
    "display_name": "Rottweiler",
    "id": -137,
    "images": [
        {
            "deleted": false,
            "description": "",
            "file": {
                "basename": "shutterstock_534443167 (1)",
                "checksum": [
                    87,
...
                    253
                ],
                "content_type": {
                    "extensions": [
                        "jpg",
                        "jpeg",
                        "jpe",
                        "jfif"
                    ],
                    "id": 15,
                    "name": "image/jpeg"
                },
                "content_type_id": 15,
                "description": "",
                "extension": "jpg",
                "id": -343,
                "stored_at": "2017-03-10T05:16:19.589197-05:00"
            },
            "id": -129,
            "image": {
                "id": -343
            },
            "sort_order": 100,
            "tags": null
        }
    ],
    "is_temp": false,
    "metrics": [
        {
            "deleted": false,
            "id": -675,
            "name": "Disposition",
            "value": "4"
        },
        {
            "deleted": false,
            "id": -674,
            "name": "Bark",
            "value": "8"
        },
        {
            "deleted": false,
            "id": -673,
            "name": "Trainability",
            "value": "6"
        },
        {
            "deleted": false,
            "id": -672,
            "name": "Energy",
            "value": "6"
        },
        {
            "deleted": false,
            "id": -671,
            "name": "Grooming",
            "value": "2"
        },
        {
            "deleted": false,
            "id": -670,
            "name": "Size",
            "value": "3"
        }
    ],
    "notes": [
        {
            "breed": {
                "id": -137
            },
            "deleted": false,
            "description": "The Rottweiler is a strong, athletic, high-energy dogs and need plenty of daily exercise including brisk daily walks, jogging, running or swimming. Do some nosework with this breed and your Rottweiler will love it. Inadequate mental stimulation can cause this breed to develop other behavior issues, such as destruction.",
            "file": null,
            "group": {
                "id": -2,
                "name": "Breed Info"
            },
            "header": "Exercise/Energy Level",
            "id": -868,
            "sort_index": 7
        },
        {
            "breed": {
                "id": -137
            },
            "deleted": false,
            "description": "Neck--Powerful, well muscled, moderately long, slightly arched and without loose skin. Topline--The back is firm and level, extending in a straight line from behind the withers to the croup. The back remains horizontal to the ground while the dog is moving or standing. Body--The chest is roomy, broad and deep, reaching to elbow, with well pronounced forechest and well sprung, oval ribs. Back is straight and strong. Loin is short, deep and well muscled. Croup is broad, of medium length and only slightly sloping. Underline of a mature Rottweiler has a slight tuck-up. Males must have two normal testicles properly descended into the scrotum. Disqualification--Unilateral cryptorchid or cryptorchid males. Tail--Tail docked short, close to body, leaving one or two tail vertebrae. The set of the tail is more important than length. Properly set, it gives an impression of elongation of topline; carried slightly above horizontal when the dog is excited or moving.",
            "file": null,
            "group": {
                "id": -3,
                "name": "Breed Standard"
            },
            "header": "Neck, Topline, Body",
            "id": -883,
            "sort_index": 4
        },
        {
            "breed": {
                "id": -137
            },
            "deleted": false,
            "description": "A male Rottweiler will stand anywhere from 24 to 27 muscular inches at the shoulder; females run a bit smaller and lighter. The glistening, short black coat with smart rust markings add to the picture of imposing strength. A thickly muscled hindquarters powers the Rottie\u2019s effortless trotting gait. A well-bred and properly raised Rottie will be calm and confident, courageous but not unduly aggressive. The aloof demeanor these world-class guardians present to outsiders belies the playfulness, and downright silliness, that endear Rotties to their loved ones. (No one told the Rottie he\u2019s not a toy breed, so he is liable plop onto your lap for a cuddle.) Early training and socialization will harness a Rottie\u2019s territorial instincts in a positive way.",
            "file": null,
            "group": {
                "id": -1,
                "name": "Overview"
            },
            "header": "About",
            "id": -3168,
            "sort_index": 2
        },
        {
            "breed": {
                "id": -137
            },
            "deleted": false,
            "description": "The Roman Empire was the organizing force behind Western Europe\u2019s formative years, and dog breeding was among the many pursuits forever altered by the Roman genius for practical problem solving. When conquering Roman legions marched to far-flung corners of the world, they brought their herds with them as food on the hoof. The army required tough, durable dogs to move and guard the herd. Utilizing Asian mastiff types as breeding stock, the Romans developed the distant ancestor of today\u2019s Rottweiler. For centuries the legions struggled to contain Germanic tribes, the so-called barbarian hoards, massed on the Empire\u2019s northern borders. The dogs the Romans brought to these areas became foundation stock for many German breeds. In the centuries after the empire\u2019s collapse, the Roman drover dogs found work in the cattle town of Rottweil. It was here, moving herds from pasture to market and protecting all concerned from bandits and rustlers along the way, that they earned the name Rottweiler Metzgerhund, or Butcher\u2019s Dog of Rottweil. The Rottie\u2019s career in livestock ended with the rise of the railroad cattle cars in the 1800s. They found new work as police dogs, personal protectors, and all-around blue-collar dogs capable of performing various heavy-duty tasks. Rotties were among the first guide dogs for the blind, and in more recent times they distinguished themselves as search-and-rescue workers at such disaster sites as Oklahoma City and the World Trade Center. Considering the many roles the breed has played during its long history, it is remarkable that the Butcher\u2019s Dog has changed little in form and temper since its first German breed standard was drawn up in 1901.",
            "file": null,
            "group": {
                "id": -1,
                "name": "Overview"
            },
            "header": "History",
            "id": -3169,
            "sort_index": 3
        },
        {
            "breed": {
                "id": -137
            },
            "deleted": false,
            "description": "The ideal Rottweiler is a medium large, robust and powerful dog, black with clearly defined rust markings. His compact and substantial build denotes great strength, agility and endurance. Dogs are characteristically more massive throughout with larger frame and heavier bone than bitches. Bitches are distinctly feminine, but without weakness of substance or structure.",
            "file": null,
            "group": {
                "id": -1,
                "name": "Overview"
            },
            "header": "Standard",
            "id": -3170,
            "sort_index": 4
        },
        {
            "breed": {
                "id": -137
            },
            "deleted": false,
            "description": "The Rottweiler should do well on a high-quality dog food, whether commercially manufactured or home-prepared with your veterinarian\u2019s supervision and approval. Any diet should be appropriate to the dog\u2019s age (puppy, adult, or senior). Some dogs are prone to getting overweight, so watch your dog\u2019s calorie consumption and weight level. Treats can be an important aid in training, but giving too many can cause obesity. Learn about which human foods are safe for dogs, and which are not. Check with your vet if you have any concerns about your dog\u2019s weight or diet. Clean, fresh water should be available at all times.",
            "file": null,
            "group": {
                "id": -1,
                "name": "Overview"
            },
            "header": "Nutrition",
            "id": -3171,
            "sort_index": 5
        },
        {
            "breed": {
                "id": -137
            },
            "deleted": false,
            "description": "The Rottweiler has a straight, coarse, medium-length outer coat that lies flat. The undercoat is present on the neck and thighs. He should be brushed weekly and bathed regularly. He sheds only very moderately for most of the year, although he will shed more profusely twice a year, usually in the spring and fall. His teeth should be brushed and nails trimmed weekly. The use of a grinding tool such as a Dremel is especially effective in trimming the nails.",
            "file": null,
            "group": {
                "id": -1,
                "name": "Overview"
            },
            "header": "Grooming",
            "id": -3172,
            "sort_index": 6
        },
        {
            "breed": {
                "id": -137
            },
            "deleted": false,
            "description": "Rottweilers love swimming, walking, and trotting, especially with their people. The breed is muscular and athletic, and should have the opportunity to exercise on a daily basis. If there are jobs to do, Rottweilers learn easily to cart and are excellent workers in herding, tracking, and obedience. There is no limit to the canine activities that the Rottweiler can learn to do. Excess weight is not good for any dog, and exercise can help to keep your Rottweiler fit and healthy.",
            "file": null,
            "group": {
                "id": -1,
                "name": "Overview"
            },
            "header": "Exercise",
            "id": -3173,
            "sort_index": 7
        },
        {
            "breed": {
                "id": -137
            },
            "deleted": false,
            "description": "The Rottweiler must be trained starting early in his life. Leadership, puppy socialization, basic training classes, and living in the owner\u2019s home are key to raising a well-mannered Rottweiler. Rottweilers are \u201cpeople dogs\u201d who do not do well isolated from humans and life experiences. No matter the breed, dogs must live in this world complete with strange animals and people. One expert in the breed notes, \u201cAs a Rottweiler owner, it is my responsibility to spend time, energy, and money giving my dog the opportunities to learn on a day-to-day basis.\u201d The breed is intelligent, highly trainable and wants to please, although some may be stubborn. It is very important that discipline be consistent, fair, and firm, without being rough. Roughhousing with the Rottweiler may encourage aggression and should be avoided. Rottweilers excel in many canine sports, and the breed works with a human partner in many functional roles.",
            "file": null,
            "group": {
                "id": -1,
                "name": "Overview"
            },
            "header": "Training",
            "id": -3174,
            "sort_index": 8
        },
        {
            "breed": {
                "id": -137
            },
            "deleted": false,
            "description": "Before breeding, responsible Rottweiler breeders have potential sires and dams tested for health problems such as hip dysplasia, a malformation of the hip joint that can be detected via X-ray; eye diseases and heart conditions. Cancer sometimes occurs in the breed, as in all dogs. David Waters, Ph.D., DVM, of the Gerald P. Murphy Cancer Foundation, has done research focused on cancer prevention funded by the Rottweiler Health Foundation. Dr. Waters has discovered that cancer and longevity are linked to a careful vaccination regimen, thus strengthening the immune system, as well as keeping males and females intact until at least six years of age.",
            "file": null,
            "group": {
                "id": -1,
                "name": "Overview"
            },
            "header": "Health",
            "id": -3175,
            "sort_index": 9
        },
        {
            "breed": {
                "id": -137
            },
            "deleted": false,
            "description": "Loyal, Loving, Confident Guardian",
            "file": null,
            "group": {
                "id": -3,
                "name": "Breed Standard"
            },
            "header": "Temperament",
            "id": -878,
            "sort_index": 10
        },
        {
            "breed": {
                "id": -137
            },
            "deleted": false,
            "description": "Working",
            "file": null,
            "group": {
                "id": -2,
                "name": "Breed Info"
            },
            "header": "Group",
            "id": -870,
            "sort_index": 2
        },
        {
            "breed": {
                "id": -137
            },
            "deleted": false,
            "description": "The Rottweiler is a trotter. His movement should be balanced, harmonious, sure, powerful and unhindered, with strong forereach and a powerful rear drive. The motion is effortless, efficient, and ground-covering. Front and rear legs are thrown neither in nor out, as the imprint of hind feet should touch that of forefeet. In a trot the forequarters and hindquarters are mutually coordinated while the back remains level, firm and relatively motionless. As speed increases the legs will converge under body towards a center line.",
            "file": null,
            "group": {
                "id": -3,
                "name": "Breed Standard"
            },
            "header": "Gait",
            "id": -866,
            "sort_index": 9
        },
        {
            "breed": {
                "id": -137
            },
            "deleted": false,
            "description": "The Rottweiler is a reliable, powerful, brave, fearless, assertive breed. Your Rottweiler is a natural guard dog, steady, composed, loyal and highly intelligent. This breed needs a lot of early socialization, great with family and friends, but wary of unfamiliar people and will chase other pets. You need to be a calm, knowledgeable, and humane owner giving consistent and committed leadership to your Rottweiler using only motivational training methods. ",
            "file": null,
            "group": {
                "id": -2,
                "name": "Breed Info"
            },
            "header": "Personality",
            "id": -869,
            "sort_index": 6
        },
        {
            "breed": {
                "id": -137
            },
            "deleted": false,
            "description": "Originated in the German town of Rottweiler in Wurttemberg, the Rottweiler was a working dog in the Middle Ages as a herding dog, guard dog, messenger dog and a police K-9. Still used today for herding and guarding, this breed is also an excellent search and rescue dog, military and police K-9, tracking, schutzhund, competitive obedience, and assistance dog for people who are sight challenged.",
            "file": null,
            "group": {
                "id": -2,
                "name": "Breed Info"
            },
            "header": "Heritage",
            "id": -871,
            "sort_index": 3
        },
        {
            "breed": {
                "id": -137
            },
            "deleted": false,
            "description": " \u00a0Grooming Requirements: \u00a0 Requires regular brushing and bathing. \u00a0Coat: Short and thick \u00a0Shedding: Average shedding \u00a0Hypoallergenic: No, due to shedding \u00a0Apartment Living: Good for apartment living if given sufficient exercise \u00a0Lap Dog: No \u00a0Good With Children: Good with all children when well socialized at an early age. \u00a0Good With Other Pets: Generally good with other pets when well socialized at an early age. ",
            "file": null,
            "group": {
                "id": -2,
                "name": "Breed Info"
            },
            "header": "Additional Information",
            "id": -874,
            "sort_index": 8
        },
        {
            "breed": {
                "id": -137
            },
            "deleted": false,
            "description": " Some assert there is a German Rottweiler and an American Rottweiler. The German Rottweiler is thought to be shorter, more thickset and burly with a big block head. The American Rottweiler is thought to be taller and leggier without the block head. Arnold, a Rottweiler, is in the HBO series Entourage A Rottweiler was in the movie Lethal Weapon 3 ",
            "file": null,
            "group": {
                "id": -4,
                "name": "Trivia"
            },
            "header": "Description",
            "id": -875,
            "sort_index": 1
        },
        {
            "breed": {
                "id": -137
            },
            "deleted": false,
            "description": "   American Canine Association Continental Kennel Club Universal Kennel Club International American Kennel Club United All Breed Registry America's Pet Registry, Inc. United Kennel Club (Based on breed recognition. See store for details on this   particular puppy.) ",
            "file": null,
            "group": {
                "id": -2,
                "name": "Breed Info"
            },
            "header": "Clubs, Registries & Associations",
            "id": -876,
            "sort_index": 1
        },
        {
            "breed": {
                "id": -137
            },
            "deleted": false,
            "description": "Faults - The foregoing is a description of the ideal Rottweiler. Any structural fault that detracts from the above described working dog must be penalized to the extent of the deviation. Disqualifications - Entropion, ectropion. Overshot, undershot (when incisors do not touch or mesh); wry mouth; two or more missing teeth. Unilateral cryptorchid or cryptorchid males. Long coat. Any base color other than black; absence of all markings. A dog that in the opinion of the judge attacks any person in the ring.",
            "file": null,
            "group": {
                "id": -3,
                "name": "Breed Standard"
            },
            "header": "Disqualifications",
            "id": -877,
            "sort_index": 11
        },
        {
            "breed": {
                "id": -137
            },
            "deleted": false,
            "description": "Always black with rust to mahogany markings. The demarcation between black and rust is to be clearly defined. The markings should be located as follows: a spot over each eye; on cheeks; as a strip around each side of muzzle, but not on the bridge of the nose; on throat; triangular mark on both sides of prosternum;on forelegs from carpus downward to the toes; on inside of rear legs showing down the front of the stifle and broadening out to front of rear legs from hock to toes, but not completely eliminating black from rear of pasterns; un-der tail; black penciling on toes. The undercoat is gray, tan, or black. Quantity and location of rust markings is important and should not exceed ten percent of body color. Serious Faults--Straw-colored, excessive, insufficient or sooty markings; rust marking other than described above; white marking any place on dog (a few rust or white hairs do not constitute a marking). Disqualifications--Any base color other than black; absence of all markings.",
            "file": null,
            "group": {
                "id": -3,
                "name": "Breed Standard"
            },
            "header": "Color",
            "id": -879,
            "sort_index": 8
        },
        {
            "breed": {
                "id": -137
            },
            "deleted": false,
            "description": "Outer coat is straight, coarse, dense, of medium length and lying flat. Undercoat should be present on neck and thighs, but the amount is influenced by climatic conditions. Undercoat should not show through outer coat. The coat is shortest on head, ears and legs, longest on breeching. The Rottweiler is to be exhibited in the natural condition with no trimming. Fault--Wavy coat. Serious Faults--Open, excessively short, or curly coat; total lack of undercoat; any trimming that alters the length of the natural coat. Disqualification--Long coat.",
            "file": null,
            "group": {
                "id": -3,
                "name": "Breed Standard"
            },
            "header": "Coat",
            "id": -880,
            "sort_index": 7
        },
        {
            "breed": {
                "id": -137
            },
            "deleted": false,
            "description": "Angulation of hindquarters balances that of forequarters. Upper thigh is fairly long, very broad and well muscled. Stifle joint is well turned. Lower thigh is long, broad and powerful, with extensive muscling leading into a strong hock joint. Rear pasterns are nearly perpendicular to the ground. Viewed from the rear, hind legs are straight, strong and wide enough apart to fit with a properly built body. Feet are somewhat longer than the front feet, turning neither in nor out, equally compact with well arched toes. Pads are thick and hard. Nails short, strong, and black. Dewclaws must be removed.",
            "file": null,
            "group": {
                "id": -3,
                "name": "Breed Standard"
            },
            "header": "Hindquarters",
            "id": -881,
            "sort_index": 6
        },
        {
            "breed": {
                "id": -137
            },
            "deleted": false,
            "description": "Shoulder blade is long and well laid back. Upper arm equal in length to shoulder blade, set so elbows are well under body. Distance from withers to elbow and elbow to ground is equal. Legs are strongly developed with straight, heavy bone, not set close together. Pasterns are strong, springy and almost perpendicular to the ground. Feet are round, compact with well arched toes, turning neither in nor out. Pads are thick and hard. Nails short, strong and black. Dewclaws may be removed.",
            "file": null,
            "group": {
                "id": -3,
                "name": "Breed Standard"
            },
            "header": "Forequarters",
            "id": -882,
            "sort_index": 5
        },
        {
            "breed": {
                "id": -137
            },
            "deleted": false,
            "description": "The ideal Rottweiler is a medium large, robust and powerful dog, black with clearly defined rust markings. His compact and substantial build denotes great strength, agility and endurance. Dogs are characteristically more massive throughout with larger frame and heavier bone than bitches. Bitches are distinctly feminine, but without weakness of substance or structure.   ",
            "file": null,
            "group": {
                "id": -3,
                "name": "Breed Standard"
            },
            "header": "General Appearance",
            "id": -885,
            "sort_index": 1
        },
        {
            "breed": {
                "id": -137
            },
            "deleted": false,
            "description": "Of medium length, broad between the ears; forehead line seen in profile is moderately arched; zygomatic arch and stop well developed with strong broad upper and lower jaws. The desired ratio of backskull to muzzle is 3 to 2. Forehead is preferred dry, however some wrinkling may occur when dog is alert. Expression is noble, alert, and self-assured. Eyes of medium size, almond shaped with well fitting lids, moderately deep-set, neither protruding nor receding. The desired color is a uniform dark brown. Serious Faults--Yellow (bird of prey) eyes, eyes of different color or size, hairless eye rim. Disqualification--Entropion. Ectropion. Ears of medium size, pendant, triangular in shape; when carried alertly the ears are level with the top of the skull and appear to broaden it. Ears are to be set well apart, hanging forward with the inner edge lying tightly against the head and terminating at approximately mid-cheek. Serious Faults--Improper carriage (creased, folded or held away from cheek/head). Muzzle--Bridge is straight, broad at base with slight tapering towards tip. The end of the muzzle is broad with well developed chin. Nose is broad rather than round and always black. Lips-Always black; corners closed; inner mouth pigment is preferred dark. Serious Faults--Total lack of mouth pigment (pink mouth). Bite and Dentition--Teeth 42 in number (20 upper, 22 lower), strong, correctly placed, meeting in a scissors bite--lower incisors touching inside of upper incisors. Serious Faults--Level bite; any missing tooth. Disqualifications--Overshot, undershot (when incisors do not touch or mesh); wry mouth; two or more missing teeth.",
            "file": null,
            "group": {
                "id": -3,
                "name": "Breed Standard"
            },
            "header": "Head",
            "id": -884,
            "sort_index": 3
        }
    ],
    "pet_type": {
        "available_pets_count": 56,
        "deleted": false,
        "has_litters": true,
        "id": -1,
        "is_enabled": true,
        "name": "Puppy",
        "plurals": {
            "Canine": "Canines",
            "Dog": "Dogs",
            "Puppy": "Puppies"
        },
        "slug": "puppies",
        "uses_band": false
    },
    "slug": "rottweilers"
}

Leads

GET /api/leads – get all leads
GET /api/leads/{lead_id} – gets a specific lead

...

Note

Please be aware that based on your access level, specific permissions, and agreements, access to certain resources may not be available.

Limits on API Usage

Currently there are two usage-based restrictions imposed while using the API.  Normal use of the API should not hit either of these, but they are listed below to make sure you are aware of them.

  • Files in our system get a unique id.  If the file is ever changed, then a new id is created, and if appropriate, the old file and referenced id is deleted.  Because of this, files (which includes images) should only be pulled once, and then cached locally within your site, server, or application.

  • The number of sessions allowed on one device or login is limited.  Sessions should be reused, instead of having a new session created for every request.  The only time a new session needs to be created is if you receive a 409 response from the API.  In that scenario, the old session has expired or has been terminated.  A new session should be created (programmatically) , and then the request should be resubmitted.

Error Responses

Error HTTP code of an error response could be one of the following:

HTTP Code

Name

Description

400

Bad request

Any other handled exception

401

Unauthorized

Access token / credentials are missing or incorrect

403

Forbidden

Permission denied

404

Not found

Resource doesn’t exist

406

Not Acceptable

Login is incorrect or the application is not accessible

409

Conflict

Request is correct, but can’t be applied because of the server state constraints

422

Validation Error

There is an error in the values passed in

500

Internal server error

Unhandled exception happens on server side