Quickstart

This walkthrough takes you through the core flow: authenticate, create an order, and receive results. Run it against your sandbox token before switching to your live token; the base URL stays the same either way.

Authenticate

Copy your sandbox token (prefixed sk_sandbox_) from the API Integration section of the admin dashboard and confirm it works by listing your credit balances.

curl https://connect.siphoxhealth.com/api/v1/credits \
  -H "Authorization: Token $SIPHOX_SANDBOX_TOKEN"

See Authentication for how the two tokens work.

Create an order and drive it to resulted

Create an order; with a sandbox token this returns a mock order and kit instead of shipping anything. Then jump the kit straight to a resulted report with the sandbox simulate endpoint.

curl -X POST https://connect.siphoxhealth.com/api/v1/create-order \
  -H "Authorization: Token $SIPHOX_SANDBOX_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient": {
      "first_name": "Jordan",
      "last_name": "Reyes",
      "email": "jordan.reyes@example.com",
      "address": { "street1": "123 Main St", "city": "Boston", "state": "MA", "zip": "02101", "country": "US" }
    },
    "kit_types": [{ "kitType": "CORE_BLOOD_PANEL", "quantity": 1 }]
  }'

curl -X POST https://connect.siphoxhealth.com/api/v1/sandbox/kits/{kitID}/simulate \
  -H "Authorization: Token $SIPHOX_SANDBOX_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "scenario": "resulted",
    "metadata": {
      "email": "jordan.reyes@example.com",
      "firstName": "Jordan",
      "lastName": "Reyes",
      "gender": "M",
      "dateOfBirth": "1990-01-15"
    }
  }'

Receive results

Subscribe to webhooks to follow the sample lifecycle, then pull the report through the same read endpoints you will use in production once the kit is resulted.

curl https://connect.siphoxhealth.com/api/v1/customers/{id}/reports/{reportID} \
  -H "Authorization: Token $SIPHOX_SANDBOX_TOKEN"

note

Sandbox kits never advance on their own. You drive every transition explicitly with the sandbox simulate and advance endpoints, and each transition fires the same webhook your integration would receive in production. See Sandbox Testing for every scenario and status.

Next steps

Kit lifecycle

Understand every status a kit and sample can move through.

API reference

Full, interactive reference for every endpoint.

Next steps​

Next steps