IWDR API Documentation

Use the IWDR API to access your organizations data stored within the IWDR database. There are many data models retrievable from the IWDR API such as, dogs, litters, health data, status histories, and much more.

Getting Started

In order to use the IWDR API you must first acquire an authentication token. You can apply for an authentication token here, if you do not already have one.

To get started, or, for an overview of the setup process, we highly recommend reading the Quickstart page. You can also visit the Authentication page for information about using your IWDR API token to make authenticated HTTP requests.

What is an API and how can it help?

An API allows you to connect your existing database with the IWDR. Many organizations need to use the IWDR for its unique breeding selection and specialized program management tools, but also need to maintain data in their own internal database. This results in time consuming and costly data entry duplication. An API resolves this by automatically duplicating some of that data for you.

What services are available?

There are a number of options around how the API can work, and the IWDR does have some limitations around what data can be managed with an API.

It is faster, cheaper, and more accurate in tying pedigrees together if you enter fresh data directly into the IWDR, and then use the API to duplicate that data into your own database.There are some cases where we can enable data duplication the other way around (e.g. data is entered in your database and duplicated to the IWDR) however this is a time consuming endeavor restricted to very large organizations with sufficient IT staffing and budget - read more on this under Option C.

Create records for the following in the IWDR, then at a frequency you choose, duplicate the data into your database:

Most useful when you want to eliminate duplicate data entry but want to have EBVs and advanced genetic tools with collaboration but need to manage the puppy raiser, clients, etc in your database

You enter your data in IWDR and then IWDR sends a copy of the data you want electronically and adds this new data to your database. Easiest, least expensive to set up and ,eliminates duplicate data entry.

IWDR is Source	YourDB is Source
New puppies IWDR is Source New puppies YourDB is Source Dog updates (names, status, key dates, microchip)	Dog updates (names, status, key dates, microchip)
Diagnosis and genetic tests IWDR is Source Diagnosis and genetic tests YourDB is Source
Behavior Checklist IWDR is Source Behavior Checklist YourDB is Source
Litters IWDR is Source Litters YourDB is Source
Other types of data you can specify in the API application IWDR is Source Other types of data you can specify in the API application YourDB is Source

Guides

Quickstart

A quick intro for understanding who this API is designed for, and how to utilize it best.

Mapping

Learn how to accurately describe data mappings used by the IWDR API to ensure data integrity.

Authentication

Learn how to authenticate your IWDR API requests.

Errors

Read about the different types of errors returned by the IWDR API, and how to accurately handle them in a production environment.

Common Resources

You must sign in to view our available API resources.