Synapse Dokumentation

WP Synapse Dokumentation

Herzlich willkommen bei WP Synapse! Diese Dokumentation hilft Ihnen bei der Einrichtung und Nutzung des Plugins, damit Sie das volle Potenzial zur Automatisierung und Überwachung Ihrer WordPress-Websites ausschöpfen können.

1. Was ist WP Synapse?

WP Synapse verwandelt Ihre WordPress-Website in eine sichere Datenschnittstelle (eine “Datenbrücke”). Statt sich für Routine-Aufgaben ständig einloggen zu müssen, können Sie mit WP Synapse wichtige Informationen über Updates, den Website-Zustand und mehr über eine moderne REST-API abfragen und sogar Aktionen aus der Ferne ausführen.

Es ist das ideale Werkzeug für Agenturen, Entwickler und Website-Betreiber, die ihre Arbeitsabläufe automatisieren und mehrere Websites effizient verwalten möchten.

• WP Synapse (Free): Der “Connector”, der auf jeder Ihrer Websites installiert wird. Er stellt die API-Endpunkte bereit und bietet ein lokales Dashboard zur Übersicht.
• WP Synapse PRO: Das zentrale “Dashboard”, das auf einer Ihrer WordPress-Installationen läuft. Es verbindet sich mit all Ihren “Connector”-Websites und ermöglicht die zentrale Verwaltung und Überwachung.
• WP Synapse ULTIMATE: Die zukünftige Erweiterung für ultimative Kontrolle und erweiterte Datenabfragen.

2. Erste Schritte: Installation der Free-Version

Bevor Sie die PRO-Version nutzen können, muss auf jeder Website, die Sie verwalten möchten, die kostenlose Basis-Version von WP Synapse installiert sein.

Voraussetzungen

• WordPress Version 5.8 oder höher
• PHP Version 7.4 oder höher

Installation

1. Gehen Sie in Ihrem WordPress-Dashboard zu Plugins > Installieren.
2. Suchen Sie nach “WP Synapse”.
3. Klicken Sie bei “WP Synapse” auf “Jetzt installieren” und anschließend auf “Aktivieren”.

Das Plugin ist nun aktiv. Im Admin-Menü finden Sie einen neuen Punkt namens “Synapse”.

3. Nutzung der Free-Version (Connector)

Jede Website mit dem kostenlosen Plugin verfügt über ein eigenes kleines Dashboard und die Möglichkeit, API-Schlüssel für den Fernzugriff zu erstellen.

3.1. Das lokale Dashboard

Navigieren Sie zu Synapse > Dashboard. Hier erhalten Sie eine schnelle Übersicht über den Zustand der aktuellen Website.

• Verfügbare Updates: Zeigt die Anzahl der anstehenden Updates für WordPress-Core, Plugins und Themes.
• Website-Zustand: Gibt den allgemeinen Status (Gut, Empfohlen, Kritisch) basierend auf den WordPress-eigenen Prüfungen wieder.

3.2. API-Schlüssel erstellen und verwalten

Um eine Website mit der PRO-Version (oder einem anderen Tool wie n8n) zu verbinden, benötigen Sie einen API-Schlüssel.

1. Gehen Sie zu Synapse > Einstellungen.
2. Im Abschnitt “Neue Anwendung autorisieren”:

• Name der Anwendung: Geben Sie einen aussagekräftigen Namen ein (z.B. “Mein PRO Dashboard” oder “n8n-Server”).
• Berechtigungen (Scopes): Wählen Sie aus, welche Daten über diesen Schlüssel abgefragt oder welche Aktionen ausgeführt werden dürfen. Für die Verbindung mit dem PRO-Dashboard wird empfohlen, alle Berechtigungen zu aktivieren.
• Klicken Sie auf “API-Key erzeugen”.

Im Bereich “Autorisierte Anwendungen” sehen Sie alle erstellten Schlüssel und können diese bei Bedarf widerrufen.

4. WP Synapse PRO: Das zentrale Dashboard

Mit der PRO-Version verwalten Sie alle Ihre Websites von einem einzigen Ort aus.

4.1. Installation der PRO-Version

1. Nach dem Kauf auf CodeCanyon laden Sie die wp-synapse-pro.zip-Datei herunter.
2. Installieren Sie das PRO-Plugin auf der WordPress-Website, die als Ihr zentrales Dashboard dienen soll. Gehen Sie dazu auf Plugins > Installieren > Plugin hochladen.
3. Wählen Sie die ZIP-Datei aus und klicken Sie auf “Jetzt installieren” und “Aktivieren”.

4.2. Lizenz aktivieren

Nach der Aktivierung werden Sie aufgefordert, Ihre Lizenz zu aktivieren.

1. Navigieren Sie zum Menüpunkt Synapse PRO > Lizenz.
2. Geben Sie Ihren Purchase Code von CodeCanyon in das dafür vorgesehene Feld ein.
3. Klicken Sie auf “Lizenz aktivieren”.

Nach erfolgreicher Aktivierung werden alle PRO-Funktionen freigeschaltet.

4.3. Websites verbinden und verwalten

Unter Synapse PRO > Websites verwalten Sie alle Ihre verbundenen “Connector”-Seiten.

Neue Website hinzufügen:

1. Klicken Sie auf den Button “Connect New Website”.
2. Ein Modal-Fenster öffnet sich. Geben Sie hier die Daten der Ziel-Website ein:

• Website URL: Die vollständige URL der Website (z.B. https://www.meinekundenseite.de).
• Alias / Label: Ein interner Name für diese Verbindung (z.B. “Kundenprojekt X”).
• API Key: Der API-Schlüssel, den Sie zuvor auf der Ziel-Website in der Free-Version generiert haben.

1. Klicken Sie auf “Test Connection”, um zu prüfen, ob die Verbindung funktioniert.
2. Bei Erfolg wird der “Save Website”-Button aktiv. Klicken Sie darauf, um die Verbindung zu speichern.

Die verbundene Website erscheint nun in der Tabelle. Hier können Sie die Verbindung erneut testen, bearbeiten oder löschen.

4.4. Das PRO Dashboard

Unter Synapse PRO > Dashboard sehen Sie eine Übersichtskarte für jede verbundene Website.

• Zustandsindikator: Ein farbiger Punkt (grün, gelb, rot) zeigt den allgemeinen Website-Zustand.
• Update-Zusammenfassung: Zeigt die Anzahl der anstehenden Plugin-, Theme- und Core-Updates.
• Metriken: Server-Antwortzeit und der Zeitpunkt der letzten Synchronisierung.
• Aktionen: Direkte Links zum Login auf der Ziel-Website oder zur Detailansicht.

4.5. Die Detailansicht & Remote-Updates

Wenn Sie im Dashboard auf “Details” klicken, gelangen Sie zur Detailansicht einer einzelnen Website.

• Updates: Sie sehen eine detaillierte Liste aller anstehenden Updates.
• Site Health Details: Eine Auflistung aller kritischen Probleme und Empfehlungen.

Updates aus der Ferne durchführen:

1. In der Update-Sektion der Detailansicht, klicken Sie neben “Plugins” oder “Themes” auf “Select Updates”.
2. Ein Fenster öffnet sich, in dem Sie auswählen können, welche spezifischen Updates Sie durchführen möchten.
3. Treffen Sie Ihre Auswahl und klicken Sie auf “Run Selected Updates”.

Das System führt nun die Updates sicher im Hintergrund auf der Ziel-Website aus.

5. WP Synapse ULTIMATE (Coming Soon)

Die ULTIMATE-Version wird die Funktionalität von WP Synapse PRO um weitere, leistungsstarke API-Endpunkte und Features erweitern, die speziell auf die Bedürfnisse von Agenturen und Power-Usern zugeschnitten sind.

Geplante Features:

• Erweiterte Endpunkte zur Abfrage von Benutzerdaten, veraltetem Inhalt und mehr.
• Möglichkeit zur Durchführung komplexer Suchanfragen.
• Integrationen mit Drittanbieter-Plugins wie WooCommerce.

Informationen zum Upgrade werden verfügbar sein, sobald die ULTIMATE-Version veröffentlicht wird.

6. API-Dokumentation

Eine vollständige technische Referenz aller verfügbaren API-Endpunkte der Free-, PRO- und ULTIMATE-Version finden Sie in unserer separaten API-Dokumentation. Diese ist für Entwickler und Nutzer von Automatisierungs-Tools wie n8n oder Zapier gedacht.

-> Zur vollständigen API-Dokumentation

7. Fehlerbehebung (Troubleshooting)

Problem: Die Verbindung zu einer Website schlägt fehl.

• Lösung 1: Stellen Sie sicher, dass die kostenlose WP Synapse Version auf der Ziel-Website installiert und aktiviert ist.
• Lösung 2: Überprüfen Sie, ob der kopierte API-Schlüssel korrekt ist. Generieren Sie bei Zweifeln einen neuen Schlüssel.
• Lösung 3: Deaktivieren Sie kurzzeitig Sicherheits-Plugins (z.B. Wordfence) auf der Ziel-Website, die möglicherweise API-Anfragen blockieren, um dies als Ursache auszuschließen.

Problem: Im PRO-Dashboard werden keine Daten angezeigt.

• Lösung: Die Daten werden automatisch alle 15 Minuten synchronisiert. Klicken Sie auf den “Refresh Data”-Button im Dashboard, um eine manuelle Synchronisierung für alle Seiten anzustoßen.

Bei weiteren Fragen oder Problemen zögern Sie nicht, unseren Support zu kontaktieren.