Transnetyx® API Resources

Getting Started

Introduction

Transnetyx provides web based API interaction with its most popular products and services. This portal serves as the primary developer hub, with links to the end-point documentation pages, product details, and code examples. Transnetyx implements its API projects using standard REST paradigms unless otherwise stated in the endpoint documentation.

API Access

The security mechanism of the Transnetyx API's are based around the X-API-KEY HTTP request header model. Developers register for a (free) account and then request keys appropriate to the prodcuts or service that they wish to integrate with. Access to the Transnetyx API platform is provided as a value-add service to partners and 3rd party vendors, and is authorized at the sole discretion of Transnetyx Inc. You must agree and adhere to the terms of the service to ensure that continued API access is permitted.

Developer Account

To obtain access to the developer dashboard a developer must first register for a standard Transnetyx Account. This account provides access to the suite of Transnetyx products and services. After the user account is created, a developer may then register their organization and request product keys.

Organizations

To allow developement teams to effectively manage their relationship with Transnetyx, access to product keys are issued to and managed via organizations. Once an organization is created, the creator can invite additional members of their development team to their organization, provide technical contact information, register for Partner verification, and manage product API keys.

Product Overview

QuickOrder

Transnetyx QuickOrder is the primary molecular diagnostics services ordering portal. The current version of the software (v1.x) provides customers with an end to end order placement and results retrieval system. The application provides these facilities for each of the diagnostic products, as listed below.

Automated Genotyping
The Automated Genotyping product is the cornerstone of Transnetyx services and provides customers with the ability to have their genetic samples tested against a reference strain using quantitative polymerase chain reaction genotyping (qPCR).

Learn more about Automated Genotyping: https://www.transnetyx.com/why-outsource

Genetic Monitoring
Genetic Monitoring from Transnetyx allows customers to gauge the relative genentic similarity between their samples and reference mouse lines.

Learn More about Genetic Monitoring: https://www.transnetyx.com/monitoring

Microbiome Analysis
Microbiome Analysis from Transnetyx provides a genetic survey of the gut microorganisms present in animal colonies by isolating DNA profiles via fecal samples.

Learn more about Microbiome Analysis: https://www.transnetyx.com/microbiome

Colony

Colony is the Breeding and Colony management product from Transnetyx. It provides a rich set of features and tools to manage colonies of experimental animals.

Learn more about Colony: https://www.transnetyx.com/colony

API Usage

Conventions

Unless otherwise specified in the endpoint documentation, Transnetyx APIs are structured to conform to RESTful patterns. They will typically expose endpoints that rely on HTTP verb invocation (GET, POST, PUT, etc.) and standard HTTP response codes. Request and Response objects conform to JSON object structures, with application/json as the Content-Type header, unless otherwise speficied. Some endpoints may also provide an alternate XML response format when requested. See the endpoint documentation to determine when an XML response structure is available.

Transnetyx uses the Swagger documentation package as the standard endpoint documentation system. Learn more about Swagger here: https://swagger.io/

For information on how to get started using REST API resource, visit: https://www.restapitutorial.com/resources.html

Data Sharing Opt-In Requirements

Transnetyx respects the privacy and data security requirements of our customers. In accordance with our customer privacy policy, data is provided via the API endpoints through a voluntary opt-in system. It is the responsibility of the developer/partner organization to solicit access to our shared customer's data. Transnetyx may, at it's sole discretion, prevent access to customer data for security or privacy concerns irrespective of their Opt-In status.

When customer data is unreachable with a response code of 403 - Forbidden, either the user or Transnetyx has prevented access to the resources requested. Contact the account owner to ensure that they have agreed to data sharing via the API system.

Environments

Transnetyx provides partners with access to a Development instance of each of the product APIs for use during integration development and testing. Please be aware that the data in these systems are subject to being changed, deleted, refreshed or updated without prior notice and are provided as-is with no warranty of any kind.

Test environments require a seperate registration and key request process. Production API keys will not authenticate in the test environments, and vice versa.

Security

Transnetyx provides partners with access to customer data via cryptographic API keys. The API platoforms monitor and in some cases record activity over the API sytems. As detailed in the Terms of Servce, it is the respondibility of partner organization to secure their key material at all times, to revoke access to key materail if it is deemed to have been compromised, and to inform Transnetyx if suspected abuse or security breaches have occured that could compromise the security or data integrety of any Transnetyx system.

Transnetyx reserves the right to revoke API key access, throttle requests, or deactivate accounts that behave in suspicious or abusive ways without notice.