Zum Hauptinhalt springen

REST API v2 – Übersicht

FeedbackPulse SaaS bietet eine RESTful API (v2) für programmatischen Zugriff auf Ihre Mandantendaten. Nutzen Sie sie, um Feedback in eigene Apps zu integrieren, Dashboards zu erstellen oder Workflows zu automatisieren.


Basis-URL

https://yourdomain.com/api/v2

Authentifizierung

Alle API-Anfragen erfordern einen Bearer-Token (API-Schlüssel):

curl -H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
https://yourdomain.com/api/v2/submissions

API-Schlüssel erhalten

  1. Melden Sie sich bei Ihrem Mandanten-Dashboard an
  2. Navigieren Sie zu Einstellungen > API-Schlüssel
  3. Klicken Sie auf API-Schlüssel erstellen
  4. Kopieren Sie den Schlüssel sofort (er wird nur einmal angezeigt!)

API-Schlüssel werden als SHA256-Hashes gespeichert. Der Rohschlüssel kann nicht wiederhergestellt werden.

Plan-Anforderung: API-Zugriff erfordert das Feature-Flag api_access in Ihrem Plan.


Rate-Limiting

LimitWert
Anfragen pro Minute pro Mandant60

Rate-Limit-Header sind in jeder Antwort enthalten:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 57

Verfügbare Endpunkte

MethodeEndpunktBeschreibung
GET/api/v2/submissionsEinreichungen auflisten
GET/api/v2/submissions/{id}Einzelne Einreichung abrufen
POST/api/v2/submissionsEinreichung erstellen
GET/api/v2/productsProdukte auflisten
POST/api/v2/productsProdukt erstellen
GET/api/v2/campaignsKampagnen auflisten
POST/api/v2/campaignsKampagne erstellen
GET/api/v2/webhooks/configWebhook-Konfiguration abrufen
PUT/api/v2/webhooks/configWebhook-Konfiguration aktualisieren
GET/api/v2/webhooks/logsWebhook-Lieferprotokolle anzeigen

Antwortformat

Alle Antworten sind JSON:

{
"data": [...],
"meta": {
"current_page": 1,
"per_page": 15,
"total": 42
}
}

Fehlerantworten

{
"error": "Unauthenticated.",
"status": 401
}
StatuscodeBedeutung
200Erfolgreich
201Erstellt
400Ungültige Anfrage (Validierungsfehler)
401Nicht autorisiert (ungültiger/fehlender API-Schlüssel)
403Verboten (unzureichende Berechtigungen)
404Nicht gefunden
429Zu viele Anfragen (Rate-Limit erreicht)
500Server-Fehler

Vertiefung