Developers

Développez avec l'API ScoreStory

ScoreStory dispose d'une API REST publique. Tout ce que vous pouvez faire dans l'interface avec les enquêtes, invitations, répondants, résultats et campagnes d'e-mails, vous pouvez aussi le faire via l'API — depuis votre propre intégration, ou depuis un agent IA agissant en votre nom. Hébergée dans l'UE, sur les mêmes points de terminaison que ceux utilisés par l'application elle-même.

Référence de l'API Documentation interactive pour chaque point de terminaison. Schéma OpenAPI La spécification lisible par machine (OpenAPI 3, JSON).

Prise en main

  1. Créez un jeton dans l'application, en tant qu'administrateur, sous Organisation → Jetons API. Limitez-le à ce dont votre intégration a réellement besoin, et fixez une expiration si possible.
  2. Appelez GET /api/public-api/v1/me pour vérifier quel espace de travail, quels scopes et quelle restriction d'enquête le jeton possède.
  3. Effectuez votre premier appel :
# 1. Que peut faire ce jeton ?
curl -s https://app.scorestory.eu/api/public-api/v1/me \
  -H "Authorization: Bearer $SCORESTORY_TOKEN"

# 2. Créer une enquête (requis : name, metric_type, interview_locale)
#    metric_type : nps | enps | csat | ces | scale
curl -s -X POST https://app.scorestory.eu/api/surveys \
  -H "Authorization: Bearer $SCORESTORY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Q3 pulse","metric_type":"nps","interview_locale":"fr"}'

# 3. Inviter quelqu'un
curl -s -X POST https://app.scorestory.eu/api/surveys/<survey_id>/invitations/personal \
  -H "Authorization: Bearer $SCORESTORY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"recipient_email":"sam@example.com","recipient_name":"Sam"}'

Ce que vous pouvez faire

  • Créer, lire, mettre à jour, dupliquer et supprimer des enquêtes
  • Gérer les propriétés et thèmes des répondants
  • Créer, réémettre, révoquer et envoyer par e-mail des invitations personnelles et des liens partagés
  • Lire les répondants et leurs transcriptions ; supprimer un répondant (RGPD)
  • Lire les résultats : vue d'ensemble, scores individuels, conclusion écrite, thèmes avec citations, évolution dans le temps
  • Créer, planifier, envoyer, mettre en pause des campagnes d'e-mails et en lire les statistiques

Règles de base

Les limites de débit s'appliquent par jeton ; une réponse 429 comporte un en-tête Retry-After indiquant combien de temps attendre. Les erreurs se présentent toujours sous la forme {"error": {"code": "...", "message": "..."}} — testez code, pas le texte du message. Le versionnage est additif : les champs ne sont ajoutés qu'au sein d'une version majeure, jamais supprimés ni réaffectés. Il n'y a pas encore de webhooks — interrogez les points de terminaison de résultats par sondage.

Pour les agents IA

Si vous êtes un agent agissant pour le compte de quelqu'un, commencez par llms.txt — il présente les mêmes informations sous une forme lisible par machine. Vous aurez besoin d'un jeton API d'espace de travail pour agir : il n'existe aucun moyen d'en créer un de façon programmatique, demandez donc à la personne pour qui vous travaillez d'en créer un sous Organisation → Jetons API et de vous le transmettre.

Questions

Contactez-nous à welcome@scorestory.eu.

Dernière mise à jour : 7 septembre 2026.