Client SDKs

HVAKR provides official client SDKs to simplify API integration in your applications.

Available SDKs

TypeScript/JavaScript

For Node.js and browser applications.

Installation:

npm install @hvakr/client

Repository: https://github.com/flowcircuits/hvakr-client

Python

For Python applications and scripts.

Installation:

pip install hvakr

Repository: https://github.com/flowcircuits/hvakr-python

TypeScript SDK

Basic Usage

import { HvakrClient } from '@hvakr/client'

const client = new HvakrClient({ apiKey: process.env.HVAKR_API_KEY })

// List projects
const projects = await client.projects.list()

// Get project details
const project = await client.projects.get('project-id')

// Get load calculations
const loads = await client.projects.getLoads('project-id')

Available Methods

Projects:

• projects.list() - List all projects
• projects.get(id) - Get project details
• projects.create(data) - Create new project
• projects.update(id, data) - Update project

Calculations:

• projects.getLoads(id) - Get load calculations
• projects.getVentilation(id) - Get ventilation data

Reports:

• projects.exportReport(id, format) - Export report

Python SDK

Basic Usage

from hvakr import HvakrClient

client = HvakrClient(api_key=os.environ['HVAKR_API_KEY'])

# List projects
projects = client.projects.list()

# Get project details
project = client.projects.get('project-id')

# Get load calculations
loads = client.projects.get_loads('project-id')

Available Methods

Projects:

• projects.list() - List all projects
• projects.get(id) - Get project details
• projects.create(data) - Create new project
• projects.update(id, data) - Update project

Calculations:

• projects.get_loads(id) - Get load calculations
• projects.get_ventilation(id) - Get ventilation data

Authentication

Both SDKs support:

API Key

Set via constructor or environment variable:

const client = new HvakrClient({ apiKey: 'your-key' })

Environment Variable

export HVAKR_API_KEY=your-key

The SDK will automatically use the environment variable.

Error Handling

TypeScript

try {
    const project = await client.projects.get('id')
} catch (error) {
    if (error.status === 404) {
        console.log('Project not found')
    }
}

Python

try:
    project = client.projects.get('id')
except NotFoundError:
    print('Project not found')

Best Practices

1. Use environment variables for API keys
2. Handle errors appropriately
3. Cache results when possible
4. Check SDK version for updates