Entwicklerreferenz

Integrationsleitfaden

Die reine Markdown-API-Referenz lesen →

Melden Sie sich mit Google oder einem E-Mail-Verifizierungscode an und öffnen Sie dann Dashboard → API-Schlüssel. Kopieren Sie den Schlüssel, wenn er angezeigt wird: In unserer Datenbank wird nur sein SHA-256-Hash gespeichert. Bestehende Nutzer können einen Legacy-Schlüssel über sein privates Verwaltungs-Token verknüpfen.

Serverseitige Prüfung

POST /api/v1/check
Content-Type: application/json
x-api-key: YOUR_API_KEY

{
  "text": "Can you quote this project?",
  "email": "[email protected]"
}

Antworten enthalten verdict (allow, block, review), score, reason, engine (jev oder rules), model (Anbieterversion bei KI-Ergebnissen), execution_time_ms und unserer quota_remaining. Scores aus Regeln sind heuristische Schätzungen. Confidence ist nur bei Jev vorhanden. Behandeln Sie review als unsicher, nicht als automatische Blockierung.

Statuscodes: 400 (ungültige Eingabe), 401 (fehlender Schlüssel), 403 (ungültiger Schlüssel), 429 (Kontingent ausgeschöpft), 503 (Dienst nicht verfügbar). Maximale Nachrichtengröße: 10,000 Zeichen. Optional business_context (bis zu 1,000 Zeichen) beschreibt erwünschte Anfragen; keine Geheimnisse angeben. Bei Anbieterausfall wird auf lokale heuristische Regeln zurückgegriffen.

Erkennungsprotokolle und Ausführungsberichte

Dashboard → Erkennungsprotokolle zeigt Ihre letzten 7 Tage authentifizierter Prüfungen. Wählen Sie Unsicher — prüfen im Urteilsfilter, um unsichere Ergebnisse zu untersuchen. Dies ist eine Aufzeichnung von Prüfungen und gemeldeten Aktionen, kein Posteingang und keine Warteschlange zum Aufbewahren oder Wiederherstellen von Nachrichten. Optionales site (eine HTTP/HTTPS-URL; nur deren Hostname wird gespeichert) und form_id (bis zu 80 Buchstaben, Zahlen, Unterstriche, Doppelpunkte oder Bindestriche) identifizieren Ihre Integration. Nachrichtentext ist standardmäßig deaktiviert und kann in Ihrem Konto aktiviert werden. Öffentliche Demo-Prüfungen sind ausgeschlossen.

Erfolgreiche Protokollierung fügt hinzu check_id und unserer report_token zur Check-Antwort; logging_status ist saved oder unavailable. Protokollierungsfehler ändern die Klassifizierung nicht. Bewahren Sie das Report-Token auf Ihrem Server auf. Nachdem Sie Ihre Entscheidung angewendet haben, senden Sie per POST an /api/v1/report mit demselben API-Schlüssel:

{
  "check_id": "CHECK_UUID",
  "report_token": "TOKEN_FROM_CHECK",
  "action": "allowed",
  "reason": "verdict"
}

Zulässige Aktionswerte: allowed, blocked, oder error_allowed. Das neueste WordPress-Plugin meldet seine Aktion automatisch. Observe only meldet allowed mit dem Grund observe. Ein fehlender oder fehlgeschlagener Bericht erscheint als Not reported; eine allowed-Aktion bestätigt keine E-Mail-Zustellung.

Bei einer benutzerdefinierten API-Integration ist Beobachtung eine Richtlinie in Ihrem eigenen Servercode: Rufen Sie den Prüf-Endpunkt auf, zeichnen Sie das Urteil auf, setzen Sie Ihren normalen Einsendungsablauf fort und melden Sie die von Ihnen angewandte Aktion. Die Prüf-API aktiviert oder deaktiviert die Blockierung in Ihrem Formular nicht automatisch. Die Beobachtung verarbeitet weiterhin Nachrichteninhalt und verbraucht Erkennungskontingent.

Optionaler Browser-Helfer

<form data-formshield> ... </form>
<script src="https://jevshield.com/shield.js" data-key="YOUR_API_KEY"></script>

Der Helfer prüft nur ausdrücklich markierte Formulare, sendet Nachrichten-, E-Mail- und Namensfelder und erlaubt die Einsendung nach einem Netzwerkfehler oder 6-Sekunden-Timeout. Er ist umgehbar und legt den API-Schlüssel gegenüber Besuchern offen. Verwenden Sie serverseitige Prüfungen zur Durchsetzung und um den Schlüssel privat zu halten. Testen Sie AJAX-Formular-Plugins, bevor Sie ihn aktivieren.

Lead-Routing

Öffnen Sie Dashboard → Routing, um Ihr Unternehmen zu beschreiben und optional eine Webhook- oder Buchungs-URL zu speichern. Der Kontokontext wird verwendet, wenn eine Anfrage keinen eigenen business_context bereitstellt. Ergebnisse mit hoher Kaufabsicht können Anfrage- und Kontaktdaten an Ihren konfigurierten Webhook senden; verwenden Sie ein Ziel, das Sie kontrollieren, und decken Sie diese Verarbeitung in Ihrer Datenschutzerklärung ab.

Eine konfigurierte Buchungs-URL wird als meeting_url für Ergebnisse mit hoher Kaufabsicht zurückgegeben. Ihre Integration entscheidet, ob sie angezeigt oder aufgerufen wird. Das WordPress-Plugin und individuelle Integrationen können unterschiedliches Verhalten aufweisen; überprüfen Sie den vollständigen Besucherfluss. Ein Webhook-Test verwendet eine synthetische Anfrage und bestätigt die HTTP-Antwort des Ziels, nicht die nachgelagerte Zustellung.

Routing-Einstellungen öffnen →

WordPress

Laden Sie das neueste JevShield-Plugin-ZIP herunter, installieren Sie es in WordPress, öffnen Sie dann Einstellungen → JevShield AI und geben Sie Ihren API-Schlüssel und den vollständigen HTTPS /api/v1/check-Endpunkt ein. Wählen Sie unter Protection Mode die Option Observe only, um zu klassifizieren und zu protokollieren, ohne dass dieses Plugin blockiert. Neue Installationen starten in Observe only; bestehende konfigurierte Installationen behalten die Blockierung bei, bis Sie den Modus ändern. Die Beobachtung verbraucht Kontingent und überträgt Übermittlungsfelder zur Verarbeitung, beschreiben Sie sie daher in Ihrer Datenschutzerklärung. Überprüfen Sie die tatsächliche Zustellung Ihres Formulars, bevor Sie zu Block high-confidence spam wechseln.

JevShield ist auch aufgeführt in der WordPress.org-Plugin-Verzeichnis. Verzeichnis-Releases können später als das ZIP hier erscheinen; wenn Protection Mode fehlt, aktualisieren Sie mit dem neuesten ZIP. Das separate Legacy-Plugin FormShield behält seine bestehenden Einstellungen und seinen Update-Pfad. Seine Einstellungen für business-context und exakte E-Mail-Überschreibung wurden dem JevShield-Plugin nicht hinzugefügt. Die API akzeptiert weiterhin business_context für benutzerdefinierte Integrationen.