Chaindoc logoChaindoc

Installation

Vollständige Installationsanleitung für Chaindoc-SDKs. Richte das Server-SDK für die Backend-Integration und das Embed-SDK für die Frontend-Signatur-Schnittstelle ein.

Voraussetzungen

Installation des Server-SDK

Das Server-SDK wird für die Backend-Integration verwendet – Dokumentenverwaltung, Signaturanfragen und Blockchain-Verifizierung.

Schritt 1: Paket installieren

npm install @chaindoc_io/server-sdk

Schritt 2: Konfigurier die Umgebungsvariablen

Erstell eine .env-Datei im Stammverzeichnis deines Projekts:

.env
# Production keys
CHAINDOC_SECRET_KEY=sk_live_xxxxxxxxxxxxx

# Staging/Testing keys
# CHAINDOC_SECRET_KEY=sk_test_xxxxxxxxxxxxx

# Optional: Custom API endpoint
# CHAINDOC_API_URL=https://api.chaindoc.io

Schritt 3: SDK starten

lib/chaindoc.ts
import { Chaindoc } from '@chaindoc_io/server-sdk';

// Basic initialization
export const chaindoc = new Chaindoc({
  secretKey: process.env.CHAINDOC_SECRET_KEY!,
});

// Advanced configuration
export const chaindocAdvanced = new Chaindoc({
  secretKey: process.env.CHAINDOC_SECRET_KEY!,
  baseUrl: process.env.CHAINDOC_API_URL, // Optional
  timeout: 60000, // 60 seconds
  retry: {
    maxRetries: 5,
    baseDelayMs: 1000,
    maxDelayMs: 10000,
  },
  headers: {
    'X-Custom-Header': 'value',
  },
});

Schritt 4: Verbindung überprüfen

terminal
// Test API connection
const health = await chaindoc.healthCheck();

if (health.status === 'ok' && health.apiKeyValid) {
  console.log('✓ Connected to Chaindoc API');
  console.log('User ID:', health.userId);
} else {
  console.error('✗ Connection failed');
}

Einbettung der SDK-Installation

Das Embed SDK bietet eine Signatur-Schnittstelle für Webanwendungen. Funktioniert mit jedem JavaScript-Framework.

Schritt 1: Paket installieren

npm install @chaindoc_io/embed-sdk

Schritt 2: Konfigurier die Umgebungsvariablen

# .env.local
REACT_APP_CHAINDOC_PUBLIC_KEY=pk_live_xxxxx
# or for Next.js
NEXT_PUBLIC_CHAINDOC_PUBLIC_KEY=pk_live_xxxxx

Schritt 3: Initialisieren Sie in Ihrer App

// hooks/useChaindoc.ts
import { useRef, useEffect } from 'react';
import { ChaindocEmbed } from '@chaindoc_io/embed-sdk';

export function useChaindoc() {
  const sdkRef = useRef<ChaindocEmbed | null>(null);

  useEffect(() => {
    sdkRef.current = new ChaindocEmbed({
      publicKey: process.env.REACT_APP_CHAINDOC_PUBLIC_KEY!,
      environment: 'production',
    });

    return () => {
      sdkRef.current?.destroy();
    };
  }, []);

  return sdkRef.current;
}

Framework-spezifische Einrichtung

Next.js (App-Router)

app/providers.tsx
'use client';

import { createContext, useContext, useEffect, useRef } from 'react';
import { ChaindocEmbed } from '@chaindoc_io/embed-sdk';

const ChaindocContext = createContext<ChaindocEmbed | null>(null);

export function ChaindocProvider({ children }: { children: React.ReactNode }) {
  const sdkRef = useRef<ChaindocEmbed | null>(null);

  useEffect(() => {
    if (!sdkRef.current) {
      sdkRef.current = new ChaindocEmbed({
        publicKey: process.env.NEXT_PUBLIC_CHAINDOC_PUBLIC_KEY!,
      });
    }

    return () => {
      sdkRef.current?.destroy();
    };
  }, []);

  return (
    <ChaindocContext.Provider value={sdkRef.current}>
      {children}
    </ChaindocContext.Provider>
  );
}

export const useChaindoc = () => useContext(ChaindocContext);

Next.js (Pages Router)

pages/_app.tsx
import type { AppProps } from 'next/app';
import { useEffect, useRef } from 'react';
import { ChaindocEmbed } from '@chaindoc_io/embed-sdk';

export default function App({ Component, pageProps }: AppProps) {
  const sdkRef = useRef<ChaindocEmbed | null>(null);

  useEffect(() => {
    sdkRef.current = new ChaindocEmbed({
      publicKey: process.env.NEXT_PUBLIC_CHAINDOC_PUBLIC_KEY!,
    });

    return () => {
      sdkRef.current?.destroy();
    };
  }, []);

  return <Component {...pageProps} />;
}

Nuxt 3

plugins/chaindoc.client.ts
import { ChaindocEmbed } from '@chaindoc_io/embed-sdk';

export default defineNuxtPlugin(() => {
  const config = useRuntimeConfig();
  
  const chaindoc = new ChaindocEmbed({
    publicKey: config.public.chaindocPublicKey,
  });

  return {
    provide: {
      chaindoc,
    },
  };
});

Angular

services/chaindoc.service.ts
import { Injectable, OnDestroy } from '@angular/core';
import { ChaindocEmbed } from '@chaindoc_io/embed-sdk';
import { environment } from '../environments/environment';

@Injectable({
  providedIn: 'root'
})
export class ChaindocService implements OnDestroy {
  private sdk: ChaindocEmbed;

  constructor() {
    this.sdk = new ChaindocEmbed({
      publicKey: environment.chaindocPublicKey,
    });
  }

  getSdk(): ChaindocEmbed {
    return this.sdk;
  }

  ngOnDestroy(): void {
    this.sdk.destroy();
  }
}

TypeScript-Konfiguration

Beide SDKs haben komplette TypeScript-Definitionen. Du brauchst keine zusätzlichen @types-Pakete.

tsconfig.json
{
  "compilerOptions": {
    "target": "ES2020",
    "module": "ESNext",
    "moduleResolution": "bundler",
    "lib": ["ES2020", "DOM", "DOM.Iterable"],
    "types": ["node"],
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true
  }
}

Umgebungskonfiguration

Entwicklungsumgebung

terminal
// Use test keys for development
const chaindoc = new Chaindoc({
  secretKey: 'sk_test_xxxxx',
  baseUrl: 'https://api.chaindoc.io',
});

const embed = new ChaindocEmbed({
  publicKey: 'pk_test_xxxxx',
  environment: 'staging',
  debug: true, // Enable detailed logs
});

Produktionsumgebung

terminal
// Use live keys for production
const chaindoc = new Chaindoc({
  secretKey: process.env.CHAINDOC_SECRET_KEY!, // sk_live_xxxxx
});

const embed = new ChaindocEmbed({
  publicKey: process.env.NEXT_PUBLIC_CHAINDOC_PUBLIC_KEY!, // pk_live_xxxxx
  environment: 'production',
});

Überprüfung

Teste deine Installation mit diesen Überprüfungsschritten:

1SDK-Version checkenconsole.log(ChaindocEmbed.version); // Sollte die Versionsnummer ausgeben

2Überprüfe die API-Verbindung.Teste den Health-Check-Endpunkt, um zu checken, ob die API-Schlüssel okay sind.

3Testdatei hochladenLade eine kleine Testdatei hoch, um zu überprüfen, ob die Medien-Endpunkte funktionieren.

4Initialisiere das Embed SDK.Starte das SDK und schau in der Browserkonsole nach Fehlern.

Fehlerbehebung

Fehler „Modul nicht gefunden“

terminal
# Clear cache and reinstall
rm -rf node_modules package-lock.json
npm install

# For yarn
rm -rf node_modules yarn.lock
yarn install

TypeScript-Fehler

Wenn du TypeScript-Fehler siehst, überprüfe, ob deine tsconfig.json die richtigen Einstellungen für die Modulauflösung hat und die Node.js-Typen installiert sind.

terminal
npm install --save-dev @types/node

API-Schlüsselprobleme

Nächste Schritte

  • Schau dir die Schnellstartanleitung für deine erste Integration an.
  • Schau in der API-Dokumentation nach den Endpunkt-Referenzen.
  • Schau dir die SDK-Dokumentation an, um mehr über die erweiterten Funktionen zu erfahren.
  • Richte Webhooks für Echtzeitbenachrichtigungen ein.
  • Tritt der Entwickler-Community auf GitHub bei, um Support zu bekommen.