Aller au contenu principal

Aperçu de l'API REST v2

FeedbackPulse SaaS fournit une API RESTful (v2) pour l'accès programmatique à vos données de locataire. Utilisez-la pour intégrer le feedback dans vos propres applications, créer des tableaux de bord ou automatiser des flux de travail.


URL de base

https://yourdomain.com/api/v2

Authentification

Toutes les requêtes API nécessitent un token Bearer (clé API) :

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

Obtenir une clé API

  1. Connectez-vous à votre tableau de bord locataire
  2. Allez à Paramètres > Clés API
  3. Cliquez sur Créer une clé API
  4. Copiez la clé immédiatement (elle n'est affichée qu'une seule fois !)

Les clés API sont stockées sous forme de hachages SHA256. La clé brute ne peut pas être récupérée.

Exigence de plan : L'accès à l'API nécessite l'indicateur de fonctionnalité api_access sur votre plan.


Limitation de débit

LimiteValeur
Requêtes par minute par locataire60

Les en-têtes de limite de débit sont inclus dans chaque réponse :

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

Points de terminaison disponibles

MéthodePoint de terminaisonDescription
GET/api/v2/submissionsLister les soumissions
GET/api/v2/submissions/{id}Obtenir une soumission
POST/api/v2/submissionsCréer une soumission
GET/api/v2/productsLister les produits
POST/api/v2/productsCréer un produit
GET/api/v2/campaignsLister les campagnes
POST/api/v2/campaignsCréer une campagne
GET/api/v2/webhooks/configObtenir la configuration webhook
PUT/api/v2/webhooks/configMettre à jour la configuration webhook
GET/api/v2/webhooks/logsVoir les journaux de livraison webhook

Format de réponse

Toutes les réponses sont en JSON :

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

Réponses d'erreur

{
"error": "Unauthenticated.",
"status": 401
}
Code de statutSignification
200Succès
201Créé
400Requête invalide (erreur de validation)
401Non autorisé (clé API invalide/manquante)
403Interdit (permissions insuffisantes)
404Non trouvé
429Trop de requêtes (limitation de débit)
500Erreur serveur

Pour aller plus loin