🚀 API-Dokumentation

Vollständige REST API für GDPR-konforme Datenlöschung und Compliance-Automatisierung. Integrieren Sie Supacheap nahtlos in Ihre bestehenden Systeme mit unserer entwicklerfreundlichen API.

REST API v2.0
OAuth 2.0 & API Keys
OpenAPI 3.0 Spec

REST API v2.0

Moderne RESTful API mit JSON-Responses, HTTP-Status-Codes und vollständiger OpenAPI 3.0 Spezifikation.

99.9% Uptime

Sichere Authentifizierung

OAuth 2.0, API Keys und JWT-Token für maximale Sicherheit. Rate Limiting und IP-Whitelisting inklusive.

Enterprise-grade

SDKs & Libraries

Offizielle SDKs für JavaScript, Python, PHP, Java, C# und Ruby. Community-Support für weitere Sprachen.

6 Sprachen

API-Features

Leistungsstarke Entwickler-Tools für nahtlose Integration

RESTful Design

HTTP-Standards & JSON

Saubere REST-Architektur mit vorhersagbaren URLs, HTTP-Verben und standardisierten Status-Codes für intuitive Integration.

  • HTTP-konforme Verben (GET, POST, PUT, DELETE)
  • JSON Request/Response Format
  • Standardisierte HTTP-Status-Codes
  • Konsistente URL-Struktur

Sichere Authentifizierung

OAuth 2.0 & API Keys

Mehrschichtige Sicherheit mit OAuth 2.0, API Keys, JWT-Token und erweiterten Sicherheitsfeatures für Enterprise-Anwendungen.

  • OAuth 2.0 Authorization Code Flow
  • API Key Authentication
  • JWT Token mit Refresh-Mechanismus
  • Rate Limiting & IP-Whitelisting

SDKs & Libraries

6 Programmiersprachen

Offizielle SDKs für alle gängigen Programmiersprachen mit ausführlicher Dokumentation und Code-Beispielen.

  • JavaScript/Node.js SDK
  • Python SDK mit Type Hints
  • PHP SDK (PSR-4 kompatibel)
  • Java SDK (Maven & Gradle)

Umfassende Dokumentation

OpenAPI 3.0 Spec

Vollständige OpenAPI 3.0 Spezifikation mit interaktiven Beispielen, Postman-Collections und Entwickler-Guides.

  • OpenAPI 3.0 Spezifikation
  • Interaktive API-Explorer
  • Postman Collections
  • Code-Beispiele für alle Endpoints

Quick Start Guide

In 4 einfachen Schritten zur ersten API-Integration

1

API Key erstellen

Registrieren Sie sich für einen kostenlosen Account und erstellen Sie Ihren ersten API Key im Dashboard.

2

SDK installieren

Installieren Sie das SDK für Ihre bevorzugte Programmiersprache über npm, pip, composer oder Maven.

3

Ersten Request senden

Authentifizieren Sie sich mit Ihrem API Key und senden Sie Ihren ersten Request an die API.

4

Integration testen

Testen Sie Ihre Integration mit unserem Sandbox-Environment bevor Sie in Produktion gehen.

Code-Beispiele

Praktische Beispiele für schnellen Einstieg

JavaScript
Python
PHP
cURL
// JavaScript SDK - Datenlöschung initiieren
import { SupacheapClient } from '@supacheap/sdk';

const client = new SupacheapClient({
  apiKey: 'your-api-key',
  environment: 'sandbox' // oder 'production'
});

// Löschantrag erstellen
const deleteRequest = await client.deletion.create({
  userId: 'user-123',
  email: 'user@example.com',
  reason: 'GDPR Article 17',
  systems: ['database', 'backups', 'logs'],
  options: {
    includeBackups: true,
    generateCertificate: true
  }
});

console.log('Löschantrag erstellt:', deleteRequest.id);

// Status überwachen
const status = await client.deletion.getStatus(deleteRequest.id);
console.log('Status:', status.progress);

API Endpoints

Vollständige Übersicht aller verfügbaren Endpoints

POST
/api/v2/deletion/requests

Löschantrag erstellen

Erstellt einen neuen GDPR-konformen Löschantrag für personenbezogene Daten eines Benutzers.

Parameter:

userId string required Eindeutige Benutzer-ID
email string required E-Mail-Adresse des Benutzers
reason string required Grund für die Löschung (GDPR Artikel)
systems array optional Liste der zu löschenden Systeme
GET
/api/v2/deletion/requests/{id}

Löschstatus abfragen

Ruft den aktuellen Status und Fortschritt eines Löschantrags ab.

Parameter:

id string required ID des Löschantrags
GET
/api/v2/deletion/certificate/{id}

Löschzertifikat herunterladen

Lädt das offizielle GDPR-Löschzertifikat für einen abgeschlossenen Löschantrag herunter.

Parameter:

id string required ID des Löschantrags
format string optional Format des Zertifikats (pdf, json)
POST
/api/v2/compliance/audit

Compliance-Audit starten

Initiiert ein vollständiges Compliance-Audit für alle gespeicherten Daten.

Parameter:

scope string required Audit-Umfang (full, incremental)
systems array optional Zu auditierenden Systeme
GET
/api/v2/users/{id}/data

Benutzerdaten exportieren

Exportiert alle gespeicherten Daten eines Benutzers gemäß GDPR Artikel 20 (Datenportabilität).

Parameter:

id string required Benutzer-ID
format string optional Export-Format (json, csv, xml)
PUT
/api/v2/users/{id}/consent

Einwilligung aktualisieren

Aktualisiert die Einwilligungseinstellungen eines Benutzers für verschiedene Datenverarbeitungszwecke.

Parameter:

id string required Benutzer-ID
purposes object required Einwilligungen für verschiedene Zwecke

SDKs & Libraries

Offizielle SDKs für alle gängigen Programmiersprachen

JavaScript / Node.js

Vollständiges SDK für Browser und Node.js mit TypeScript-Unterstützung und automatischer Typisierung.

v2.1.0
npm install

Python

Python SDK mit Type Hints, Async/Await-Unterstützung und vollständiger Pytest-Integration.

v2.0.3
pip install

PHP

PSR-4 kompatibles PHP SDK mit Composer-Unterstützung für Laravel, Symfony und andere Frameworks.

v2.0.1
Composer install

Java

Enterprise-ready Java SDK mit Maven und Gradle-Unterstützung, Spring Boot-Integration inklusive.

v2.0.0
Maven Central

C# / .NET

.NET Standard 2.0 kompatibles SDK für .NET Framework, .NET Core und .NET 5+.

v1.9.2
NuGet Package

Ruby

Ruby Gem mit Rails-Integration und vollständiger RSpec-Testsuite für robuste Entwicklung.

v1.8.5
Gem install

Starten Sie mit unserer API

Integrieren Sie GDPR-konforme Datenlöschung und Compliance-Automatisierung in wenigen Minuten. Kostenloser API-Zugang mit 1000 Requests/Monat.

API Key erhalten API Explorer öffnen