Getting Started

This guide will help you install and configure the de.iterate SDK in your project.

Prerequisites

• Node.js 18+ (or Bun 1.0+, Deno 1.40+)
• A de.iterate account with API access
• An API key from your de.iterate dashboard

Installation

Install the SDK using your preferred package manager:

bun

bun add @deiterate/sdk

npm

npm install @deiterate/sdk

yarn

yarn add @deiterate/sdk

pnpm

pnpm add @deiterate/sdk

Configuration

Basic Setup

Create a client instance with your API credentials:

import { DeIterateClient } from '@deiterate/sdk';

const client = new DeIterateClient({
  apiKey: process.env.DEITERATE_API_KEY,
  organizationId: process.env.DEITERATE_ORG_ID,
});

Configuration Options

Option	Type	Required	Description
apiKey	string	✅	Your de.iterate API key
organizationId	string	✅	Your organization/tenancy ID
baseUrl	string	❌	Custom API base URL (default: production)
timeout	number	❌	Request timeout in ms (default: 30000)
retries	number	❌	Number of retry attempts (default: 3)

Environment Variables

We recommend storing credentials in environment variables:

# .env
DEITERATE_API_KEY=deit_your_api_key_here
DEITERATE_ORG_ID=your_organization_id
DEITERATE_API_URL=https://api.deiterate.com/v1  # Optional

import 'dotenv/config';
import { DeIterateClient } from '@deiterate/sdk';

const client = new DeIterateClient({
  apiKey: process.env.DEITERATE_API_KEY!,
  organizationId: process.env.DEITERATE_ORG_ID!,
  baseUrl: process.env.DEITERATE_API_URL,
});

Your First Request

Let's make your first API call to list risks:

import { DeIterateClient } from '@deiterate/sdk';

const client = new DeIterateClient({
  apiKey: process.env.DEITERATE_API_KEY!,
  organizationId: process.env.DEITERATE_ORG_ID!,
});

async function main() {
  try {
    // List all risks
    const response = await client.risks.list();
    
    console.log(`Found ${response.data.length} risks`);
    
    for (const risk of response.data) {
      console.log(`- ${risk.name} (${risk.status})`);
    }
  } catch (error) {
    console.error('Error:', error.message);
  }
}

main();

Available Resources

The SDK provides access to all de.iterate platform resources:

Resource	Description
client.risks	Risk management and assessment
client.controls	Control definitions and testing
client.assets	Asset inventory management
client.tasks	Task and workflow management
client.policies	Policy document management
client.processes	Business process documentation
client.documents	Document library
client.users	User management
client.compliance	Compliance status tracking
client.frameworks	Framework management
client.webhooks	Webhook subscriptions
client.ai	AI-powered suggestions

Next Steps

• Quick Start - Build something in 5 minutes
• Authentication - Learn about API tokens
• Error Handling - Handle errors gracefully
• API Reference - Explore all available methods