Anleitung zur Nutzung des RBS Events API Plugins

Allgemein

0  Kommentare

Share0
Tweet0
Share0
Share0
Tweet0
Share0

Anleitung zur Nutzung des RBS Events API Plugins

Datum: 20. September 2024

Einführung

Das RBS Events API Plugin erweitert Ihr WordPress-System um eine REST API Schnittstelle, die es ermöglicht, Event-Daten aus dem Events Manager Plugin abzurufen. Mit dieser API können Sie Events in externe Anwendungen und Automatisierungstools wie make.com oder Zapier integrieren.

Hinweis: Kunden mit einem aktiven Mentoring oder Support Platin Programm können das Plugin kostenfrei nutzen. Für alle anderen Nutzer kostet das Plugin 69,- Euro pro Jahr und Domain.

Funktionen des Plugins

  • Bereitstellung von Event-Daten über die REST API
  • Filterung von Events nach verschiedenen Kriterien
  • Lizenzierung zur Kontrolle des Zugriffs auf die API
  • Integration mit Automatisierungstools

Voraussetzungen

  • WordPress Version 5.0 oder höher
  • Events Manager Plugin installiert und aktiviert
  • Gültiger Lizenzschlüssel für das RBS Events API Plugin
    • Hinweis: Kunden mit einem aktiven Mentoring oder Support Platin Programm erhalten den Lizenzschlüssel kostenfrei.
  • PHP Version 7.4 oder höher

Installation

  1. Plugin erwerben
    • Kunden mit aktivem Mentoring oder Support Platin Programm:
      • Sie erhalten den Lizenzschlüssel und das Plugin direkt von uns.
    • Andere Nutzer:
      • Das Plugin kann für 69,- Euro pro Jahr und Domain erworben werden.
      • Bitte kontaktieren Sie uns unter support@redfox-business.com, um das Plugin zu erwerben.
  2. Plugin hochladen
    • Navigieren Sie im WordPress-Dashboard zu Plugins > Installieren.
    • Klicken Sie auf Plugin hochladen und wählen Sie die rbs-events-api.zip Datei aus.
    • Klicken Sie auf Jetzt installieren.
  3. Plugin aktivieren
    • Nach der Installation klicken Sie auf Plugin aktivieren.
  4. Lizenzschlüssel eingeben
    • Gehen Sie zu Einstellungen > RBS Events API.
    • Geben Sie Ihren Lizenzschlüssel ein.
    • Speichern Sie die Einstellungen.
    • Der Lizenzstatus wird angezeigt (gültig oder ungültig).

Verwendung der REST API

Endpoint-URL

https://ihre-domain.de/wp-json/rbs-events-api/v1/events

Anfrageparameter

  • scope (optional)
    • Beschreibung: Bestimmt den Zeitraum der Events.
    • Mögliche Werte:
      • future (Standard) – zukünftige Events
      • past – vergangene Events
      • all – alle Events
  • limit (optional)
    • Beschreibung: Begrenzung der Anzahl der zurückgegebenen Events.
    • Wert: Ganzzahl (z. B. 5 für die ersten fünf Events)

Beispielanfragen

  1. Alle zukünftigen Events abrufenhttps://ihre-domain.de/wp-json/rbs-events-api/v1/events
  2. Vergangene Events abrufenhttps://ihre-domain.de/wp-json/rbs-events-api/v1/events?scope=past
  3. Die nächsten 5 Events abrufenhttps://ihre-domain.de/wp-json/rbs-events-api/v1/events?limit=5
  4. Alle Events ohne Begrenzunghttps://ihre-domain.de/wp-json/rbs-events-api/v1/events?scope=all

Zurückgegebene Daten

Die API liefert eine JSON-Antwort mit einer Liste von Events. Jedes Event enthält die folgenden Felder:

  • id: Event-ID
  • name: Name des Events
  • start_time: Startzeit des Events
  • end_time: Endzeit des Events
  • start_date: Startdatum des Events
  • end_date: Enddatum des Events
  • location: Name des Veranstaltungsortes
  • address: Adresse des Veranstaltungsortes
  • city: Stadt des Veranstaltungsortes
  • description: Beschreibung des Events
  • url: URL zur Event-Seite

Beispiel einer JSON-Antwort:

[
  {
    "id": 123,
    "name": "Frühlingsfest",
    "start_time": "18:00",
    "end_time": "22:00",
    "start_date": "2023-05-01",
    "end_date": "2023-05-01",
    "location": "Stadtpark",
    "address": "Hauptstraße 1",
    "city": "Musterstadt",
    "description": "Ein Fest für die ganze Familie.",
    "url": "https://ihre-domain.de/event/fruehlingsfest"
  },
  {
    "id": 124,
    "name": "Sommerkonzert",
    ...
  }
]

Integration mit Automatisierungstools

Beispiel: Verwendung mit make.com

  1. HTTP-Modul einrichten
    • Fügen Sie ein HTTP-Modul hinzu.
    • Stellen Sie die Methode auf GET.
    • Geben Sie die Endpoint-URL ein, z. B.:https://ihre-domain.de/wp-json/rbs-events-api/v1/events?scope=future&limit=5
  2. Daten verarbeiten
    • Verwenden Sie die erhaltenen Daten, um Aktionen wie das Senden von E-Mails, Aktualisieren von Kalendern oder Posten in sozialen Medien auszuführen.

Fehlerbehandlung

Mögliche Fehlermeldungen

  • Ungültige Lizenz
    • Beschreibung: Die Lizenz ist ungültig oder abgelaufen.
    • HTTP-Statuscode: 403 Forbidden
    • Antwort: 
      {
  "code": "invalid_license",
  "message": "Die Lizenz für dieses Plugin ist ungültig oder abgelaufen.",
  "data": {
    "status": 403
  }
}
  • Events Manager Plugin nicht aktiv
    • Beschreibung: Das benötigte Events Manager Plugin ist nicht installiert oder aktiviert.
    • HTTP-Statuscode: 404 Not Found
    • Antwort: 
      {
  "code": "no_events_manager",
  "message": "Das Events Manager Plugin ist nicht aktiv.",
  "data": {
    "status": 404
  }
}
  • Keine Events gefunden
    • Beschreibung: Es wurden keine Events entsprechend den Filterkriterien gefunden.
    • HTTP-Statuscode: 200 OK
    • Antwort: Leeres Array []

Häufig gestellte Fragen (FAQ)

1. Wie erhalte ich einen Lizenzschlüssel?

  • Kunden mit aktivem Mentoring oder Support Platin Programm:
    • Sie erhalten den Lizenzschlüssel kostenfrei von uns. Bitte kontaktieren Sie Ihren Ansprechpartner oder schreiben Sie an support@redfox-business.com.
  • Andere Nutzer:
    • Das Plugin kann für 69,- Euro pro Jahr und Domain erworben werden. Kontaktieren Sie uns unter support@redfox-business.com, um den Lizenzschlüssel zu erwerben.

2. Kann ich weitere Filter hinzufügen?

Derzeit unterstützt die API die Filter scope und limit. Für weitere Filtermöglichkeiten können Sie das Plugin anpassen oder uns kontaktieren. Wir bieten individuelle Lösungen und Erweiterungen an.

3. Die API liefert keine Events zurück, obwohl welche vorhanden sind. Woran liegt das?

  • Überprüfen Sie die Filterkriterien: Stellen Sie sicher, dass Ihre Anfrageparameter korrekt sind.
  • Events Status: Stellen Sie sicher, dass die Events veröffentlicht und nicht als Entwurf gespeichert sind.

4. Wie kann ich die API sichern oder den Zugriff einschränken?

Standardmäßig ist die API öffentlich zugänglich. Um den Zugriff zu beschränken, können Sie die permission_callback in der Plugin-Datei anpassen oder eine Authentifizierungsmethode implementieren. Bei Bedarf unterstützen wir Sie gerne dabei.

5. Das Plugin funktioniert nach einem Update nicht mehr. Was soll ich tun?

  • Überprüfen Sie die Kompatibilität: Stellen Sie sicher, dass alle Plugins auf dem neuesten Stand sind.
  • Fehlermeldungen prüfen: Aktivieren Sie das WordPress-Debugging, um Fehler zu identifizieren.
  • Kontaktieren Sie uns: Wenn das Problem weiterhin besteht, wenden Sie sich an unseren Support. Kunden mit aktivem Mentoring oder Support Platin Programm erhalten bevorzugten Support.

Problembehandlung

1. Lizenz wird als ungültig angezeigt

  • Überprüfen Sie den Lizenzschlüssel: Stellen Sie sicher, dass er korrekt eingegeben wurde.
  • Lizenzstatus prüfen: Ist die Lizenz abgelaufen oder deaktiviert?
  • Internetverbindung: Stellen Sie sicher, dass Ihr Server eine Verbindung zum Lizenzserver herstellen kann.
  • Debugging aktivieren: Überprüfen Sie das debug.log für detaillierte Fehlermeldungen.
  • Support kontaktieren: Bei anhaltenden Problemen helfen wir Ihnen gerne weiter.

2. REST API Endpoint ist nicht erreichbar

  • Permalinks aktualisieren: Gehen Sie zu Einstellungen > Permalinks und klicken Sie auf Änderungen speichern.
  • Sicherheitsplugins prüfen: Stellen Sie sicher, dass keine Plugins die REST API blockieren.
  • Serverkonfiguration: Überprüfen Sie die .htaccess-Datei oder Servereinstellungen.

3. Fehlermeldung: „Das Events Manager Plugin ist nicht aktiv“

  • Plugin installieren: Laden Sie das Events Manager Plugin herunter und installieren Sie es.
  • Plugin aktivieren: Stellen Sie sicher, dass das Plugin aktiviert ist.
  • Version prüfen: Verwenden Sie die neueste Version des Events Manager Plugins.

Support

Wenn Sie Fragen haben oder Unterstützung benötigen, können Sie uns gerne kontaktieren:

RedFoX Business Solutions BV

Hinweis: Kunden mit einem aktiven Mentoring oder Support Platin Programm erhalten bevorzugten Support und können das Plugin kostenfrei nutzen.

Schlusswort

Das RBS Events API Plugin bietet eine leistungsstarke Möglichkeit, Ihre Event-Daten in externe Systeme zu integrieren und automatisierte Workflows zu erstellen. Wir hoffen, dass diese Anleitung Ihnen den Einstieg erleichtert. Für weitere Informationen oder individuelle Anpassungen stehen wir Ihnen gerne zur Verfügung.

Vielen Dank für Ihr Vertrauen in RedFoX Business Solutions BV.

Tags

Das war hilfreich, oder Du hast Fragen? Hinterlasse gerne einen Kommentar
{"email":"Email address invalid","url":"Website address invalid","required":"Required field missing"}