GuidesAPI References
GuidesAPI References
  1. Authentication
  • Authentication
    • Obtain access token
      POST
    • Generate magic link
      POST
  • Manage tests
    • Generate draft test
      POST
    • Run CCSTest
      POST
    • Get CCSTest result
      GET
  • Schemas
    • TestResponse
    • PatientReport
    • ApiResponse
GuidesAPI References
GuidesAPI References
  1. Authentication

Obtain access token

POST
/api/organization-auth/authenticate
Validates clientId and clientSecret parameters, then returns a JWT access token. Use the returned accessToken in the Authorization header as 'Bearer {token}' for subsequent API calls. Token expires after 3600 seconds.

Request

Body Params application/jsonRequired

Examples

Responses

🟢200OK
application/json
Authentication successful - JWT token issued
Body

🟠400Bad Request
🟠401Unauthorized
🔴500Internal Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.cardioexplorer.ai/api/organization-auth/authenticate' \
--header 'Content-Type: application/json' \
--data-raw '{
    "clientId": "12345678-1234-1234-1234-123456789abc",
    "clientSecret": "your-client-secret-here",
    "scope": "api.read api.write"
}'
Response Response Example
200 - Success
{
    "status": "success",
    "message": "Authentication successful",
    "errors": null,
    "data": {
        "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
        "tokenType": "Bearer",
        "expiresIn": 3600,
        "organization": {
            "organizationId": "550e8400-e29b-41d4-a716-446655440000",
            "azureClientId": "12345678-1234-1234-1234-123456789abc",
            "organizationName": "Organization Name",
            "contactEmail": "admin@organization.com",
            "accessLevel": 2,
            "isActive": true,
            "rateLimitPerHour": 1000,
            "allowedIpAddresses": "10.0.0.0/8",
            "createdAt": "2024-01-15T10:30:00Z",
            "updatedAt": "2024-01-20T14:45:00Z",
            "lastAccessedAt": "2024-01-25T09:15:00Z",
            "totalApiCalls": 2847,
            "createdByUserEmail": "admin@cardioexplorer.com",
            "metadata": "{\"department\":\"IT\",\"region\":\"US-East\"}"
        }
    }
}
Modified at 2026-01-28 13:23:30
Next
Generate magic link
Built with