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
- Melden Sie sich bei Ihrem Mandanten-Dashboard an
- Navigieren Sie zu Einstellungen > API-Schlüssel
- Klicken Sie auf API-Schlüssel erstellen
- 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_accessin Ihrem Plan.
Rate-Limiting
| Limit | Wert |
|---|---|
| Anfragen pro Minute pro Mandant | 60 |
Rate-Limit-Header sind in jeder Antwort enthalten:
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 57
Verfügbare Endpunkte
| Methode | Endpunkt | Beschreibung |
|---|---|---|
GET | /api/v2/submissions | Einreichungen auflisten |
GET | /api/v2/submissions/{id} | Einzelne Einreichung abrufen |
POST | /api/v2/submissions | Einreichung erstellen |
GET | /api/v2/products | Produkte auflisten |
POST | /api/v2/products | Produkt erstellen |
GET | /api/v2/campaigns | Kampagnen auflisten |
POST | /api/v2/campaigns | Kampagne erstellen |
GET | /api/v2/webhooks/config | Webhook-Konfiguration abrufen |
PUT | /api/v2/webhooks/config | Webhook-Konfiguration aktualisieren |
GET | /api/v2/webhooks/logs | Webhook-Lieferprotokolle anzeigen |
Antwortformat
Alle Antworten sind JSON:
{
"data": [...],
"meta": {
"current_page": 1,
"per_page": 15,
"total": 42
}
}
Fehlerantworten
{
"error": "Unauthenticated.",
"status": 401
}
| Statuscode | Bedeutung |
|---|---|
200 | Erfolgreich |
201 | Erstellt |
400 | Ungültige Anfrage (Validierungsfehler) |
401 | Nicht autorisiert (ungültiger/fehlender API-Schlüssel) |
403 | Verboten (unzureichende Berechtigungen) |
404 | Nicht gefunden |
429 | Zu viele Anfragen (Rate-Limit erreicht) |
500 | Server-Fehler |
Vertiefung
- Authentifizierung — API-Schlüssel-Details
- Einreichungen-API — Feedback erstellen und auflisten
- Produkte-API — Produkte verwalten
- Kampagnen-API — Kampagnen verwalten
- Webhooks — Echtzeit-Ereignisbenachrichtigungen