WPSubscription Pro umfasst die Unterstützung von REST API für die programmgesteuerte Durchführung von Abonnementaktionen. Diese Funktion ermöglicht es Entwicklern und Automatisierungstools, Abonnements remote über sichere API-Anfragen zu verwalten.

API-Einstellungen

Um die REST API-Funktionalität zu aktivieren und darauf zuzugreifen:

  1. Gehe zu WPSubscription > Einstellungen > API-Einstellungen

  2. Aktiviere REST API-Endpunkte für Abonnementaktionen aktivieren

  3. Kopiere die REST API-Endpunkt-URL, die bereitgestellt wird

  4. Verwende oder regeneriere den API-Schlüssel zur Authentifizierung

Halte deinen API-Schlüssel sicher. Er muss in jeder API-Anfrage enthalten sein.
Screenshot von 2025-06-02 16-13-57.png

Verfügbare Abonnementaktionen

Jede API-Anfrage muss als POST-Anfrage an folgende Adresse gesendet werden:

/wp-json/wpsubscription/v1/action

Jede Anfrage muss Folgendes enthalten:

  • action: Art der durchzuführenden Operation (z.B. cancel_subscription)

  • subscription_id: ID des abzulehnenden Abonnements

  • api_key: Dein vom Plugin generierter API-Schlüssel

  • data: Optionale zusätzliche Informationen (z.B. Grund für die Stornierung)

Unterstützte Aktionen

Aktion

Beschreibung

Beispielanwendung

cancel_subscription

Storniert ein aktives Abonnement

Auslösen aus CRM, wenn der Kunde abwandert

pause_subscription

Setzt ein Abonnement auf Hold (ausstehend)

Urlaubsunterbrechung oder Zahlungsproblem

resume_subscription

Reaktiviert ein pausiertes Abonnement

Reaktivierung der Abrechnung nach Pause

change_status

Ändert den Status auf: aktiv, ausstehend, storniert, abgelaufen

Synchronisation mit externem System oder Admin-Regel

reactivate_subscription

Reaktiviert ein storniertes Abonnement

Manuelle Übersteuerung durch Support oder CRM

expire_subscription

Markiert das Abonnement manuell als abgelaufen

Zeitlich begrenzte Pläne oder Zwangsablauf

trial_end

Benutzerdefinierte Logik am Ende der kostenlosen Testphase auslösen

Umwandlung von kostenlos zu bezahlt in anderen Systemen

payment_failed

Protokollieren oder reagieren auf fehlgeschlagene Verlängerungsversuche

Mahnung-Workflows, CRM-Alarm

verify_api

Überprüfen der Gültigkeit des API-Schlüssels

Verbindungstest von externem Tool

Beispiel JSON-Anfrage

Screenshot von 2025-06-02 16-14-17.png

So setzen Sie ein Abonnement über Postman oder ein externes System fort:

POST /wp-json/wpsubscription/v1/action
{
  "action": "resume_subscription",
  "subscription_id": 168,
  "api_key": "your-api-key",
  "data": {
    "reason": "Kundenanfrage"
  }
}

Beispiel für eine erfolgreiche JSON-Antwort

{
  "status": "success",
  "message": "Abonnementaktion \"resume_subscription\" erfolgreich verarbeitet",
  "subscription_id": 168
}

Protokolle & Debugging

Alle REST-API-Aktivitäten werden im WooCommerce > Status > Protokolle unter der Protokolldatei mit dem Namen subscription-pro-api-YYYY-MM-DD protokolliert.

Screenshot von 2025-06-02 16-13-36.png

Jedes Protokoll enthält:

  • Zeitstempel

  • Aktionstyp

  • Abonnement-ID

  • Status (verarbeitet oder Fehler)

  • Nutzlastdaten (falls vorhanden)

Authentifizierung & Sicherheit

  • Alle API-Aufrufe erfordern den API-Schlüssel für den Zugriff.

  • API-Schlüssel können jederzeit in den API-Einstellungen neu generiert werden.

  • Schlüssel sollten sicher gespeichert und nicht in öffentlichen Anfragen offengelegt werden.

Fehlerbehandlung

REST-Antworten geben geeignete Fehlercodes für ungültige Eingaben oder Fehlerzustände zurück.

Fehlercode

Bedeutung

rest_forbidden

Ungültiger oder fehlender API-Schlüssel

not_found

Abonnement-ID nicht gefunden

invalid_status

Der angegebene Statuswert ist ungültig

action_failed

Allgemeiner Aktionsfehler

Überprüfen Sie immer, dass Ihr Anfragekörper Folgendes enthält:

  • Gültiger API-Schlüssel

  • Richtiger Aktionsname

  • Gültige Abonnement-ID