SDK Overview

Official TruSec SDKs for popular programming languages

Official SDKs

TruSec provides official SDKs to make integration easy and idiomatic in your preferred language.

JavaScript / TypeScript

Full-featured SDK for Node.js, browsers, and edge runtimes

Python

Pythonic SDK with async support and type hints

Go

Lightweight SDK for Go applications (coming soon)

Ruby

Ruby SDK with Rails integration (coming soon)

Installation

JavaScript

npm install @trusec/sdk
# or
yarn add @trusec/sdk
# or
pnpm add @trusec/sdk

Python

pip install trusec
# or
poetry add trusec

Go

go get trusec.io/go

Quick Start

JavaScript

import { TruSec } from '@trusec/sdk';

const trusec = new TruSec({
  apiKey: process.env.TRUSEC_SECRET_KEY,
});

// Verify a session
const session = await trusec.sessions.verify({
  token: userToken,
});

// Check permissions
const allowed = await trusec.permissions.check({
  principal: session.user.id,
  action: 'read',
  resource: 'documents/123',
});

Python

from trusec import TruSec
import os

trusec = TruSec(
    api_key=os.environ.get("TRUSEC_SECRET_KEY")
)

# Verify a session
session = trusec.sessions.verify(token=user_token)

# Check permissions
allowed = trusec.permissions.check(
    principal=session.user.id,
    action="read",
    resource="documents/123"
)

Features

All official SDKs include:

Type Safety

Full TypeScript definitions and Python type hints for excellent IDE support and compile-time safety.

Automatic Retries

Built-in retry logic with exponential backoff for transient failures.

Error Handling

Rich error types with detailed information for debugging.

Logging

Configurable logging for debugging and monitoring.

Testing Utilities

Mock clients and testing helpers for unit and integration tests.

Configuration Options

All SDKs support the following configuration options:

Option	Description	Default
apiKey	Your TruSec API key	Required
baseUrl	API base URL	https://api.trusec.io
timeout	Request timeout in ms	30000
retries	Number of retry attempts	3
debug	Enable debug logging	false

Community SDKs

Community-maintained SDKs for additional languages:

Language	Package	Maintainer
PHP	trusec/php-sdk	Community
Java	io.trusec:sdk	Community
.NET	TruSec.SDK	Community

Community SDKs are not officially supported. Use at your own risk and check for compatibility with the latest API version.

Need Help?

API Reference

Detailed API documentation

Discord

Get help from the community