Quickstart

This guide is aimed to help an organization get started with using the IWDR API. It contains important information about mapping your organization data, authenticating API requests, handling errors, and more.

Who is this for

• IT staff with database experience, including import/export of data, mapping, and a good understanding of field names
• Organizations with IT capability and sufficient data volume that strongly desire to reduce dual entry

Getting Started

Firstly, you must already be an IWDR subscriber. If you aren’t, you can enroll here.

1. Submit an API Application. You can access our API documentation and guide here: https://api-docs.iwdr.org/ Log in with your existing IWDR details and you will see the API Access Application link in the top right corner of the page.
   • Once your application is submitted, we will contact you to arrange a meeting and discuss your needs, migration requirements, your database type, a timeframe, and costs.

What is required to begin

API implementation is a time-consuming process for both your own organization, and the IWDR staff.

• Your oganizations responsibilites:

  • If you are not already an IWDR subscriber, you must enroll first.
  • You must then also apply your organization to become an IWDR API user in order to obtain an authentication token/API key. You can apply for access here. You will need to confirm your specific requirements from this process, so we can be sure your needs are met.
  • Data cleansing your source data to ensure it is ready for entry into the IWDR. This includes reviewing ancestral dog records, birthdates, litters etc (comprehensive list included later in this document). You may need staff familiar with your dogs/lines to enter missing data. We will review data and send it back to you if we find errors.
  • For your dogs, as well as their sire and dam, map their respective primary dog key to the matching IWDR DogID and store the IWDR DogID in your database prior to API implementation.
  • Maintain these data requirements moving forward - the API will not parse data where the IWDR DogID and owner ID do not match between the source and receiving databases or when required data maps are missing. Additional data integrity checks are also made depending on the data type. However, some types of bad data such as incorrect birthdates etc. can not be detected.

• IWDR will provide:

  • Use of the IWDR Connector middleware program. Written in python this program can aid your organization with data mapping and transfer by using structured mapping files alongside a Command Line Interface (CLI) to create a seamless connection between your existing data set and the IWDR API.

    The currently supported data sources are:

    1. MySQL
    2. Microsoft Access
    3. Microsoft SQL Server
    4. Salesforce

  • An API data mapping interface within the IWDR interface's top level menu >> Manage our lists >> API Mappings.

  • Template mapping structures for common data structures.

  • Full use of this IWDR API documentation website's restricted content which has many examples of typical API tasks and data model structures.

  • A sandbox environment for your organization to understand usage and structures without hurting the integrity of the live data set.

  • Support with initial data migrations. This is typically requried for organizations with large pre-existing data sets.