Aller au contenu
TellMeHow Documentation
fr

Documentation de l’API

Pilotez vos audits par l’API

Une API REST et un serveur MCP par espace : préparez vos missions, suivez les entretiens et publiez le livrable depuis vos outils ou depuis Claude.

Parcourir la référence Connecter Claude
opérations REST
262
modules
12
outils MCP
184

URL de base

Chaque espace a sa propre API, sur son sous-domaine. Remplacez {votre-espace} par l’adresse de votre espace (celle que vous ouvrez dans le navigateur).

URL 
https://{votre-espace}.tellmehow.io/api/v1

C’est la même API que celle de l’application web : mêmes règles, mêmes rôles, mêmes contrôles. Rien n’est accessible par l’API qui ne le soit pas dans l’application pour le même membre.

Démarrer en trois étapes

  1. Créez une clé d’API

    Dans votre espace, menu « API et intégrations », onglet « Clés API » : nommez la clé, choisissez sa portée (lecture seule, ou lecture et écriture) et sa durée. Copiez-la tout de suite : elle ne sera plus affichée.

  2. Appelez l’API

    Passez la clé dans l’en-tête Authorization. Par exemple, pour lister les cinq missions les plus récentes :

    Terminal 
    curl "https://{votre-espace}.tellmehow.io/api/v1/engagements?limit=5" \
  -H "Authorization: Bearer pat_…"

  3. Explorez la référence

    Chaque opération est décrite dans la référence, module par module, avec un exemple prêt à copier. Le contrat OpenAPI se télécharge pour générer un client dans votre langage.

Versionnement

La version de l’API fait partie du chemin : /api/v1. Au sein d’une version, l’API évolue sans rien casser.

  • Ajouts sans préavis : nouvelles opérations, nouveaux champs facultatifs, nouvelles valeurs d’une liste. Votre code doit ignorer ce qu’il ne connaît pas.
  • Rien n’est retiré ni renommé dans une version publiée : un changement incompatible ouvre une nouvelle version (/api/v2), annoncée à l’avance.
  • Les codes d’erreur sont stables : un code existant garde son sens.

Pour aller plus loin