Skip to main content

General

Welcome to the BGT API documentation. This guide covers everything you need to integrate with the Bloody Good Tests platform.

Getting Started​

  • Getting Started - Create an account, organisation, and API key
  • Authentication - OAuth 2.0 authentication
  • Workflow - How referral ordering and results delivery fit together end-to-end
  • REST API - Complete API reference for referrals, results, tests, and bundles
  • Webhooks - Real-time event notifications
  • Changelog - Notable changes to the REST API

Environments​

Production​

  • API Base URL: https://api.bloodygoodtests.com.au
  • Auth Service: https://auth.bloodygoodtests.com.au

Staging​

  • API Base URL: https://api.staging.bloodygoodtests.com.au
  • Auth Service: https://auth.staging.bloodygoodtests.com.au

The staging environment provides a safe space to develop and test your integration without affecting production data. All features available in production are also available in staging. We recommend thoroughly testing your implementation in staging before moving to production.

Support​

For API access, integration support, or questions: