REST API

L'API REST est disponible sous /api/v1 et convient aux scripts, aux services internes, à l'intégration continue (CI), aux exports et à d'autres automatisations côté serveur.

Pour les endpoints protégés, un jeton d'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 permissions.

Autorisation

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

Authorization: Bearer <token>

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

Exemple de requête

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

Remplacez {org} par l'ID de l'organisation. Pour les paramètres de chaque endpoint, le format de la réponse et les codes d'erreur, consultez la spécification complète.

Documentation complète

• Référence OpenAPI — 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 contrat.