REST API

L'API REST est disponible sous /api/v1 et convient aux scripts, services internes, CI, exports et autres automatisations côté serveur.

Pour les endpoints protégés, un jeton API personnel est nécessaire. La requête est exécutée au nom de l'utilisateur qui a émis le jeton et passe par les mêmes vérifications de rôles et de droits.

Autorisation

Transmettez le jeton dans l'en-tête HTTP :

Authorization: Bearer <token>

La manière d'émettre, de stocker et de révoquer les jetons est décrite dans l'article Jetons API.

Exemple de requête

curl -sS "$PLATFORM_BASE_URL/api/v1/{org}/surveys" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $PLATFORM_API_TOKEN"

Remplacez {org} par l'ID de l'organisation. Les paramètres de l'endpoint spécifique, le format de réponse et les codes d'erreur sont détaillés dans la spécification complète.

Limites de requêtes

L'API est protégée contre la surcharge par une limitation de fréquence :

• API applicative autorisée : 300 requêtes par minute par utilisateur ou par IP.
• Webhook du fournisseur de paiement : 600 requêtes par minute.
• Endpoints publics (/status, fiches de la base de connaissances) : 300 requêtes par minute par IP.

En cas de dépassement de la limite, le serveur renvoie HTTP 429 Too Many Requests avec l'en-tête Retry-After (nombre de secondes avant la nouvelle tentative) et le corps d'erreur :

{
  "status": 429,
  "message": "Trop de requêtes. Réessayez dans 30 secondes.",
  "errors": {}
}

Documentation complète

• OpenAPI reference — documentation interactive sur les endpoints, les paramètres et les schémas de réponse.
• OpenAPI JSON — schéma lisible par machine pour les générateurs de clients, Postman, Insomnia et les vérifications de contrats.