Alpha Version: SignEngine is currently in alpha testing. You need an invitation to register.
Skip to main content

Installation

This guide covers installation and setup for all SignEngine SDKs and integrations.

SDK Installation​

Choose your preferred language and follow the installation instructions:

TypeScript/JavaScript​

npm install @signengine/api-client

Requirements:

  • Node.js 20 or higher
  • npm or yarn package manager

Python​

pip install signengine

Requirements:

  • Python 3.8 or higher
  • pip package manager

PHP​

composer require signengine/signengine-php

Requirements:

  • PHP 8.0 or higher
  • Composer package manager

Java​

Add to your pom.xml:

<dependency>
    <groupId>com.signengine</groupId>
    <artifactId>signengine-java</artifactId>
    <version>1.0.0</version>
</dependency>

Requirements:

  • Java 11 or higher
  • Maven or Gradle

.NET​

dotnet add package SignEngine.SDK

Requirements:

  • .NET 6.0 or higher
  • NuGet package manager

Configuration​

After installation, configure your SDK with your API key:

import { SignEngineClient } from '@signengine/api-client';

const client = new SignEngineClient({
  apiKey: process.env.SIGNENGINE_API_KEY,
  // Optional: specify environment
  baseUrl: 'https://api.signengine.dev', // Production (default)
  // baseUrl: 'https://api-staging.signengine.dev', // Staging
});

Environment Variables​

We recommend storing your API key in environment variables:

# Linux/macOS
export SIGNENGINE_API_KEY="your-api-key-here"

# Windows PowerShell
$env:SIGNENGINE_API_KEY="your-api-key-here"

# Windows Command Prompt
set SIGNENGINE_API_KEY=your-api-key-here

Or use a .env file:

SIGNENGINE_API_KEY=your-api-key-here
SIGNENGINE_BASE_URL=https://api.signengine.dev

Verify Installation​

Test your installation with a simple API call:

async function testConnection() {
  try {
    const account = await client.account.get();
    console.log('✅ Connected successfully!');
    console.log(`Account: ${account.name}`);
  } catch (error) {
    console.error('❌ Connection failed:', error.message);
  }
}

testConnection();

Next Steps​