Page de Documentation API
FeedbackPulse fournit une page de documentation API interactive permettant aux locataires d'explorer et de tester les endpoints disponibles.
Accéder à la documentation API
Naviguez vers /api-docs depuis le tableau de bord du locataire pour consulter la référence API complète.
Regroupement des endpoints
Les endpoints sont organisés par ressource :
| Ressource | Description |
|---|---|
| Soumissions | Créer, lire, mettre à jour et gérer les soumissions de retours |
| Produits | Gérer les produits et leurs configurations |
| Campagnes | Créer et gérer les campagnes de retours |
| Webhooks | Configurer et gérer les abonnements webhook |
Détails des endpoints
Chaque entrée d'endpoint affiche les informations suivantes :
| Champ | Description |
|---|---|
| Méthode HTTP | La méthode de requête (GET, POST, PUT, DELETE) |
| URL | Le chemin complet de l'endpoint |
| Paramètres | Paramètres obligatoires et optionnels avec leurs types et descriptions |
| Exemple de requête | Corps de requête ou paramètres de requête en exemple |
| Exemple de réponse | Exemple de réponse JSON avec le code de statut |
Authentification
La page de documentation API inclut les instructions d'authentification. Toutes les requêtes API nécessitent une clé API passée dans l'en-tête de la requête :
Authorization: Bearer {your-api-key}
Les clés API peuvent être générées depuis la page Paramètres du locataire.
Copier dans le presse-papiers
Chaque endpoint inclut une commande cURL pré-construite qui peut être copiée dans le presse-papiers en un seul clic, facilitant le test des endpoints depuis le terminal.