API Reference

L'API REST Saasy Feedback te permet d'intégrer les fonctionnalités de feedback dans tes propres applications. Toutes les requêtes et réponses utilisent le format JSON.

URL de base

https://api.saasy.fr/api/v1

Authentification

Toutes les requêtes doivent inclure ta clé API dans l'en-tête X-API-Key :

X-API-Key: fbk_xxxxx

Les clés API sont préfixées par fbk_. Consulte la section Authentification pour savoir comment créer et gérer tes clés.

Limitation de débit

L'API autorise 100 requêtes par minute par clé API. Si tu dépasses cette limite, tu recevras une réponse 429 Too Many Requests. Consulte la section Erreurs pour plus de détails.

Format des réponses

Toutes les réponses de l'API suivent un format standard :

{
  "success": true,
  "data": { ... },
  "meta": {
    "requestId": "req_01HXYZ123456"
  },
  "pagination": {
    "page": 1,
    "perPage": 20,
    "total": 143,
    "totalPages": 8
  }
}

Champ	Type	Description
`success`	`boolean`	Indique si la requête a réussi.
`data`	`object`	La ressource ou la liste de ressources retournée.
`meta`	`object`	Métadonnées de la requête, dont l'identifiant unique.
`pagination`	`object`	Present uniquement sur les endpoints retournant une liste.

Conventions

Toutes les réponses sont en JSON.
Les dates sont au format ISO 8601 (ex: 2024-03-15T10:30:00.000Z).
Les identifiants sont des chaînes MongoDB ObjectId (24 caractères hexadécimaux).
Les champs optionnels absents sont omis de la réponse (non retournés comme null).