BIOS API Docs¶
Scenarios¶
- Setup: what BIOS and a client must do before the client places its first order
- Happy path: how a client places an order with BIOS when every step succeeds
Examples¶
- Get an access token: how a client gets an access token to call the BIOS API
- Create a case: how a client creates a case
- Upload the VCFs: how a client uploads a case's VCFs
- Submit a case: how a client tells BIOS it has sent all the data for a case
- Download a report: how a client downloads a case's report
- Register a webhook: how a client registers an endpoint to receive webhook events
Webhooks¶
- Webhooks: how BIOS sends events to a client, and how the client verifies them
case_sanity_checks_passed: a case's VCFs passed BIOS's sanity checkscase_sent_for_manual_review: BIOS sent a case for manual reviewreport_ready: a case's report is ready to download