Welcome to the Unidoc documentation. This guide will help you get started with our platform and show you how to integrate our services into your workflow.

Quick Start

1. Sign up for an account on the Unidoc platform
2. Generate your API keys from the dashboard
3. Install our SDK using npm or yarn
4. Initialize the client with your API key
5. Start processing documents

// Install the SDK
npm install @3cores/unidoc-sdk

// Initialize the client
import { UnidocClient } from '@3cores/unidoc-sdk';

const client = new UnidocClient({
  apiKey: 'your-api-key'
});

// Process a document
const result = await client.processDocument({
  file: documentFile,
  options: {
    extractText: true,
    detectPII: true
  }
});

Our comprehensive API allows you to integrate Unidoc's document processing capabilities directly into your applications. Below is a reference of the main endpoints and methods.

Authentication

All API requests require authentication using your API key. Include it in the header of each request:

Authorization: Bearer your-api-key

Endpoints

Our SDK provides a convenient way to interact with the Unidoc API from your applications. It's available for multiple programming languages and platforms.

Available SDKs

• JavaScript/TypeScript
• Python
• Java
• C#/.NET
• Go

JavaScript SDK Example

import { UnidocClient } from '@3cores/unidoc-sdk';

// Initialize the client
const client = new UnidocClient({
  apiKey: 'your-api-key'
});

// Process a document
async function processDocument(file) {
  try {
    const result = await client.processDocument({
      file,
      options: {
        extractText: true,
        detectPII: true,
        checkCompliance: {
          regulations: ['GDPR', 'HIPAA']
        }
      }
    });
    
    console.log('Document processed:', result);
    
    // Access extracted text
    const text = await client.getDocumentText(result.documentId);
    
    // Check for PII
    const piiResults = await client.detectPII(result.documentId);
    
    return {
      documentId: result.documentId,
      text,
      piiResults
    };
  } catch (error) {
    console.error('Error processing document:', error);
    throw error;
  }
}

At Unidoc, we take security seriously. Here's how we protect your data and ensure the security of our platform.

Data Protection

• All data is encrypted in transit using TLS 1.3
• Data at rest is encrypted using AES-256
• We maintain strict access controls to your data
• Regular security audits and penetration testing
• Compliance with industry standards and regulations

API Security

• API keys are securely stored and never displayed after creation
• Rate limiting to prevent abuse
• IP whitelisting available for enterprise customers
• Detailed audit logs of all API activities