Für Entwickler Zur Dokumentation

Scampilot API

Integriere KI-gestützten Betrugsschutz direkt in deine Anwendung. Analysiere E-Mails, SMS und Nachrichten automatisch mit unserer RESTful API.

example.js
const response = await fetch('https://scampilot.de/api/v2/checks', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json',
    'Accept': 'application/json'
  },
  body: JSON.stringify({
    type: 'email',
    content: emailContent
  })
});

const { data } = await response.json();
// { uuid: '...', risk_level: 'danger', risk_score: 95 }

Leistungsstarke API

Alles, was du für die Integration brauchst

Unsere RESTful API bietet alle Funktionen, die du benötigst, um Betrugsschutz nahtlos in deine Anwendung zu integrieren.

KI-gestützte Analyse

Automatische Erkennung von Phishing, Scams und betrügerischen Inhalten mit modernster KI-Technologie.

Echtzeit-Ergebnisse

Sofortige Analyse und Bewertung mit Risiko-Score und detaillierten Erklärungen in Sekunden.

Einfache Integration

RESTful API mit klarer Dokumentation, Code-Beispielen und SDKs für alle gängigen Programmiersprachen.

Anwendungsfälle

Vielseitig einsetzbar

Die Scampilot API kann in verschiedensten Szenarien eingesetzt werden, um deine Nutzer zu schützen.

E-Mail-Clients & Webmailer

Integriere die API in deinen E-Mail-Client oder Webmailer, um eingehende E-Mails automatisch auf Phishing und Betrug zu prüfen. Warne Nutzer vor gefährlichen Nachrichten, bevor sie darauf klicken.

  • Automatische E-Mail-Analyse beim Empfang
  • Visuelle Warnungen für gefährliche Inhalte
  • Quarantäne-Funktionen für Scam-Mails

Chat- & Messaging-Apps

Schütze deine Community vor Scams in Chat-Apps, Foren oder Social-Media-Plattformen. Analysiere Nachrichten, Links und Inhalte automatisch auf verdächtige Muster.

  • Echtzeit-Überwachung von Chat-Nachrichten
  • Automatisches Blockieren verdächtiger Links
  • Moderation von User-Generated Content

E-Commerce-Plattformen

Schütze deine Kunden vor Fake-Shops und betrügerischen Angeboten. Prüfe Produktbeschreibungen, Verkäufer-Nachrichten und externe Links automatisch auf verdächtige Inhalte.

  • Überprüfung von Verkäufer-Kommunikation
  • Analyse verdächtiger Produktlistings
  • Schutz vor gefälschten Zahlungsaufforderungen

Unternehmens-IT & Security

Erhöhe die Sicherheit deiner Unternehmens-IT durch automatische Analyse eingehender E-Mails, Attachments und Links. Reduziere das Risiko von erfolgreichen Phishing-Angriffen.

  • Integration in Mail-Server & Security-Gateways
  • Automatische Threat-Detection
  • Compliance-konforme Protokollierung

Leistungsstarke Features

API-Funktionen im Detail

Alle Funktionen, die du benötigst, um Betrugsschutz nahtlos in deine Anwendung zu integrieren.

REST API mit Sanctum

Sichere Authentifizierung mit Personal Access Tokens. Erstelle und verwalte API-Tokens über das Developer Portal.

Dokumentation

Usage Tracking & Analytics

Detaillierte Nutzungsstatistiken und Analytics für deine API-Calls. Überwache Limits und optimiere deine Integration.

Usage ansehen

Umfassende Dokumentation

Vollständige API-Dokumentation mit Code-Beispielen in JavaScript, Python, PHP und mehr. OpenAPI/Swagger Support.

Zur Doku

Risiko-Score & Indikatoren

Detaillierte Risikobewertung von 0-100 mit spezifischen Betrugs-Indikatoren und verständlichen Erklärungen.

Ausprobieren

Mehrsprachiger Support

API-Antworten auf Deutsch und Englisch verfügbar. Perfekt für internationale Anwendungen.

Mehr erfahren

100% DSGVO-konform

Alle Daten werden ausschließlich in Deutschland verarbeitet. Volle DSGVO-Compliance für deine Anwendung.

Datenschutz

Quick Start

In wenigen Minuten integriert

Mit nur wenigen Zeilen Code kannst du die Scampilot API in deine Anwendung integrieren.

API Dokumentation

Vollständige Referenz für Entwickler

Alles, was du brauchst, um die Scampilot API erfolgreich zu integrieren.

Developer Portal - Deine zentrale Verwaltung

Alle API-Ressourcen werden über unser Developer Portal verwaltet. Dort kannst du:

  • Personal Access Tokens erstellen - Sichere Sanctum-Tokens für deine Anwendungen
  • Token-Berechtigungen verwalten - Feinkörnige Kontrolle über API-Zugriff
  • API-Nutzung überwachen - Echtzeit-Statistiken und Usage Analytics
  • Rate Limits einsehen - Aktuelle Limits und verbleibende Requests
  • Dokumentation & Code-Beispiele - Ausführliche Guides und Snippets

Base URL & API Version

Aktuelle Version: v2

https://scampilot.de/api/v2

API Version v2 ist die aktuelle und empfohlene Version. Alle neuen Integrationen sollten v2 verwenden.

Authentifizierung

Die Scampilot API verwendet Personal Access Tokens mit Laravel Sanctum für sichere Authentifizierung. Alle API-Tokens werden im Developer Portal erstellt und verwaltet.

Neu: Wir nutzen jetzt Sanctum Personal Access Tokens anstelle von OAuth 2.0. Dies macht die API-Integration einfacher und sicherer. Tokens sind langlebig und müssen nicht erneuert werden.

Personal Access Token erstellen (im Developer Portal)

  1. Melde dich in deinem Scampilot Account an
  2. Öffne das Developer Portal
  3. Navigiere zu "API Tokens" oder gehe direkt zur Token-Verwaltung
  4. Klicke auf "API Token erstellen"
  5. Gib einen aussagekräftigen Namen für den Token ein (z.B. "Production App", "Mobile App")
  6. Wähle die gewünschten Berechtigungen (Abilities) aus
  7. Kopiere den generierten Token sofort (wird nur einmal angezeigt!)
  8. Speichere den Token sicher (z.B. in Umgebungsvariablen)

Wichtig: Alle Token-Verwaltung erfolgt ausschließlich über das Developer Portal. Dort kannst du Tokens widerrufen, Berechtigungen ändern und deine API-Nutzung in Echtzeit überwachen.

Token verwenden

Füge den Token im Authorization Header deiner Requests hinzu:

Authorization: Bearer {dein-token-hier}

Beispiel Request

curl -X GET https://scampilot.de/api/v2/user \
  -H "Authorization: Bearer 1|abc123..." \
  -H "Accept: application/json"

Token-Berechtigungen (Abilities)

Bei der Token-Erstellung kannst du spezifische Berechtigungen zuweisen:

  • user:read - Benutzerprofil lesen
  • plans:read - Pläne lesen
  • checks:read - Check-Ergebnisse lesen
  • checks:create - Neue Checks erstellen
  • questionnaires:read - Fragebögen lesen
  • emails:read - Inbox-E-Mails lesen

Rate Limiting

API Requests sind rate-limited, um Missbrauch zu verhindern.

Benutzertyp Limit
Authentifiziert 60 Requests pro Minute
Unauthentifiziert 10 Requests pro Minute

Rate Limit Headers

Die Response enthält Rate Limit Informationen:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
X-RateLimit-Reset: 1633024800

Fehlerbehandlung

HTTP Status Codes

Code Beschreibung
200Erfolg
201Erstellt
400Ungültige Anfrage
401Nicht authentifiziert
403Keine Berechtigung
404Nicht gefunden
422Validierungsfehler
429Zu viele Requests
500Server Fehler

Fehler Response Format

{
  "message": "The given data was invalid.",
  "errors": {
    "email": ["The email field is required."]
  }
}

Hauptendpoints

AI Scam Checks

POST /api/v2/checks

Erstelle eine neue AI-Prüfung für Text, E-Mail oder SMS.

{
  "type": "text",
  "content": "Verdächtiger Inhalt...",
  "language": "de"
}
GET /api/v2/checks/{uuid}

Rufe die vollständigen Ergebnisse einer Prüfung ab.

GET /api/v2/checks/{uuid}/status

Prüfe den Status einer laufenden Analyse.

GET /api/v2/checks Premium

Liste alle deine Prüfungen mit Pagination.

Pläne & Abonnements

GET /api/v2/plans

Liste alle verfügbaren Pläne.

GET /api/v2/plans/current Auth

Aktueller Plan und Nutzung des authentifizierten Benutzers.

GET /api/v2/plans/compare

Detaillierter Vergleich aller Pläne.

Nutzungsverfolgung

Tipp: Detaillierte Nutzungsstatistiken, Grafiken und historische Daten findest du im Developer Portal unter "Usage".

GET /api/v2/usage

Übersicht deiner API-Nutzung (heute, Monat, gesamt).

GET /api/v2/usage/can-perform/{feature}

Prüfe, ob eine Aktion durchgeführt werden kann (z.B. ai_check).

Best Practices

Tokens sicher speichern

  • Niemals Tokens in Versionskontrolle committen
  • Umgebungsvariablen verwenden
  • Tokens regelmäßig rotieren

Rate Limits beachten

  • Rate Limit Headers auswerten
  • Exponentielles Backoff implementieren
  • Request-Caching nutzen

Fehlerbehandlung

  • Alle HTTP Status Codes abfangen
  • Benutzerfreundliche Fehlermeldungen anzeigen
  • Logging für Debugging implementieren

HTTPS verwenden

  • Immer HTTPS in Produktion verwenden
  • SSL-Zertifikate validieren
  • Verschlüsselte Verbindungen sicherstellen

Transparente Preise

Wähle den Plan, der zu dir passt

Flexible Preismodelle für jeden Bedarf – von kleinen Projekten bis zu Enterprise-Lösungen.

Häufig gestellte Fragen

Alles, was du über die API wissen musst

Bereit, die API zu nutzen?

Erstelle noch heute deinen kostenlosen Account und erhalte Zugang zur Scampilot API. Keine Kreditkarte erforderlich für den Start.