Getting Started

The Tru Diagnostic API Reference is organized around REST. Our API includes predictable resource-oriented URLs (described as objects), accepts json request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

API Reference

View the latest API Reference

Testing the API

To test the Tru Diagnostic API:

  1. Create a test account in our staging environment. Once you request a provider account our team will approve it within 24 hours.
  2. Access your credentials in the Administration > Integrations > V2 API tab

Accessing Production Credentials

To access your production Tru Diagnostic API credentials, follow the same steps as for your test account, but do so in your primary production account.

Starting Production Integration

Once testing is complete, create a production account to start your official production integration.

<aside> Note: The Tru Diagnostic API doesn't support bulk updates. You can work on only one object per request.

</aside>


Authentication

The Tru Diagnostic API uses API credentials to authenticate requests. You can view and manage your API credential in the Administration > Integrations dashboard. Here you will see the TruD API tab (deprecation) as well as the V2 API tab (recommended).

<aside> Your API credentials carry many privileges, so be sure to keep them secure! Do not share your API credentials in publicly accessible areas such as GitHub, client-side code, and so forth.

</aside>

Authentication Process

Authentication to the API is performed via custom Schema and ApiKey headers. These values are available to you on the Administration > Integrations > V2 API tab once you create your Application.