Get Started in Minutes

Complete documentation to integrate quantum-safe security into your applications.

Quick Start Guide

Get up and running with QuantaShield in 4 simple steps.

Get API Credentials

# Get your API key from https://dashboard.quantashield.io
export QUANTASHIELD_API_KEY="your_api_key_here"
export QUANTASHIELD_ORG_ID="your_org_id"

Install SDK

Install the QuantaShield SDK for your language

# Python
pip install quantashield

# Node.js
npm install @quantashield/sdk

# Go
go get github.com/quantashield/sdk-go

# Java
<dependency>
    <groupId>io.quantashield</groupId>
    <artifactId>quantashield-sdk</artifactId>
    <version>1.0.0</version>
</dependency>

Initialize Client

Create a QuantaShield client instance

# Python
from quantashield import QuantaShield

client = QuantaShield(
    api_key=os.getenv("QUANTASHIELD_API_KEY"),
    org_id=os.getenv("QUANTASHIELD_ORG_ID")
)

# Node.js
import { QuantaShield } from '@quantashield/sdk';

const client = new QuantaShield({
  apiKey: process.env.QUANTASHIELD_API_KEY,
  orgId: process.env.QUANTASHIELD_ORG_ID
});

Encrypt Data

Encrypt sensitive data with quantum-safe algorithms

# Encrypt a string
encrypted = client.encrypt(
    data="sensitive_user_data",
    algorithm="KYBER_1024"
)

# Encrypt field in existing object
user = {
    "name": "John Doe",
    "ssn": "123-45-6789",
    "email": "john@example.com"
}

# Encrypt SSN only
user["ssn"] = client.encrypt_field(
    data=user["ssn"],
    field_name="ssn"
)

# Decrypt when needed
decrypted = client.decrypt(encrypted)

Success! Your data is now quantum-safe

You're now encrypting data with NIST-approved post-quantum algorithms. Check your dashboard to monitor encryption activity.

Integration Guides

Step-by-step guides to integrate QuantaShield with your existing tools.

☁️

Salesforce

Encrypt Salesforce fields without code changes

10 minutes→

🗄️

PostgreSQL

Transparent database encryption with zero downtime

15 minutes→

🍃

MongoDB

Document-level encryption for NoSQL databases

15 minutes→

💳

Stripe

Secure payment data and PII tokenization

10 minutes→

☁️

AWS S3

Encrypt objects before storing in S3

10 minutes→

📊

REST APIs

Proxy any REST API through QuantaShield

5 minutes→

API Examples

Common use cases and code examples.

Field-Level Encryption

Encrypt specific fields in your database records

# Example: Encrypt user PII
client.encrypt_fields(
    table="users",
    fields=["ssn", "credit_card", "email"],
    algorithm="KYBER_1024"
)

# Queries work transparently
user = db.query("SELECT * FROM users WHERE id = ?", user_id)
# SSN is automatically decrypted if user has permission

Proxy Mode

Route API calls through QuantaShield proxy

# Instead of calling Salesforce directly:
# response = requests.post("https://api.salesforce.com/...")

# Use QuantaShield proxy:
response = requests.post(
    "https://proxy.quantashield.io/salesforce",
    headers={
        "X-QuantaShield-API-Key": api_key,
        "X-Target-Endpoint": "/services/data/v58.0/sobjects/Account"
    },
    json=account_data
)
# Sensitive fields are automatically encrypted!

Key Rotation

Rotate encryption keys without downtime

# Rotate keys for a specific table
client.rotate_keys(
    table="users",
    fields=["ssn", "credit_card"],
    new_algorithm="KYBER_1024",
    strategy="rolling"  # blue/green or rolling
)

# Check rotation status
status = client.get_rotation_status(table="users")
print(f"Progress: {status['progress']}%")

Compliance Reporting

Generate compliance reports automatically

# Generate SOC 2 compliance report
report = client.compliance.generate_report(
    framework="SOC2",
    start_date="2024-01-01",
    end_date="2024-12-31"
)

# Export to PDF
report.export_pdf("soc2_report_2024.pdf")

# Get audit trail
audit_trail = client.audit.get_events(
    table="users",
    action="decrypt",
    start_date="2024-01-01"
)

SDK Reference

Choose your language and start building.

Python

Installation

pip install quantashield

Read Docs GitHub

Node.js

Installation

npm install @quantashield/sdk

Read Docs GitHub

Go

Installation

go get github.com/quantashield/sdk-go

Read Docs GitHub

Java

Installation

Maven or Gradle

Read Docs GitHub

CLI Tools

Manage your QuantaShield resources from the command line.

QuantaShield CLI

# Install CLI

npm install -g @quantashield/cli

# Login

quantashield login

# List encryption keys

quantashield keys list

# Rotate keys

quantashield keys rotate --table users --fields ssn,credit_card

# Generate compliance report

quantashield compliance report --framework SOC2 --year 2024

Need Help?

Our support team is here to help you get started and answer any questions.

Contact Support Community Forum