1. Getting started
  • Getting started
    • Welcome to Cardioexplorer
    • Core Concepts
    • Developer Quickstart & Resources
  • Guides
    • FHIR Client Integration Guide
    • Integration Strategy Guide
    • Cardiac Data Requirements & Gap Analysis
  • Reference
    • API Objects & Models
    • Error Reference
  • Resources
    • Changelog
    • Frequently Asked Questions
Guides
API References
Guides
API References
  1. Getting started

Developer Quickstart & Resources

Make your first API call in under five minutes — authenticate, then walk the five-step flow.

Authenticate in 30 seconds#

All API calls require a Bearer token. Exchange your credentials once per hour:
cURL
JavaScript
Python

What you should see#

A 200 with your token and organization details:
{
  "status": "success",
  "message": "Authentication successful",
  "data": {
    "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6...",
    "tokenType": "Bearer",
    "expiresIn": 3600,
    "organization": {
      "organizationName": "Your Organization",
      "rateLimitPerHour": 1000,
      "isActive": true
    }
  }
}
A 401 means wrong credentials; a 400 lists the missing fields in errors — see the Error Reference.
💡 Tip: Cache the token and re-authenticate only shortly before the 3600 s expire — requesting a new token invalidates previously issued ones for your organization, and every call counts against your hourly allowance.

The full flow at a glance#

1.
Obtain access token — POST /api/organization-auth/authenticate
2.
Create draft test from FHIR — POST /api/fhir/draft-test
3.
Run the assessment — POST /api/ccs/v1/tests/{id}/run
4.
Get results — GET /api/ccs/v1/tests/{id}/result
5.
Generate PDF (optional) — GET /api/ccs/v1/tests/{id}/report/download

Continue with the endpoints#

📤 Create a draft test⚡ Run the assessment📊 Get the result

Related pages: Core Concepts · FHIR Client Integration Guide · Error Reference — Questions? info@explorishealth.com
Previous
Core Concepts
Next
FHIR Client Integration Guide
Built with