API-Dokumentationsseite
FeedbackPulse bietet eine interaktive API-Dokumentationsseite, über die Mandanten verfügbare Endpunkte erkunden und testen können.
Auf die API-Dokumentation zugreifen
Navigieren Sie vom Mandanten-Dashboard aus zu /api-docs, um die vollständige API-Referenz anzuzeigen.
Endpunkt-Gruppierung
Endpunkte sind nach Ressourcen geordnet:
| Ressource | Beschreibung |
|---|---|
| Einreichungen | Feedback-Einreichungen erstellen, lesen, aktualisieren und verwalten |
| Produkte | Produkte und ihre Konfigurationen verwalten |
| Kampagnen | Feedback-Kampagnen erstellen und verwalten |
| Webhooks | Webhook-Abonnements konfigurieren und verwalten |
Endpunkt-Details
Jeder Endpunkt-Eintrag zeigt die folgenden Informationen:
| Feld | Beschreibung |
|---|---|
| HTTP-Methode | Die Anfragemethode (GET, POST, PUT, DELETE) |
| URL | Der vollständige Endpunktpfad |
| Parameter | Erforderliche und optionale Parameter mit Typen und Beschreibungen |
| Beispielanfrage | Beispiel-Request-Body oder Query-Parameter |
| Beispielantwort | Beispiel-JSON-Antwort mit Statuscode |
Authentifizierung
Die API-Dokumentationsseite enthält Authentifizierungsanweisungen. Alle API-Anfragen erfordern einen API-Schlüssel, der im Request-Header übergeben wird:
Authorization: Bearer {your-api-key}
API-Schlüssel können auf der Einstellungen-Seite des Mandanten generiert werden.
Kopieren in Zwischenablage
Jeder Endpunkt enthält einen vorgefertigten cURL-Befehl, der mit einem einzigen Klick in die Zwischenablage kopiert werden kann, sodass Endpunkte einfach vom Terminal aus getestet werden können.