API Hedy

Qu’est-ce que l’API Hedy ?

L’API Hedy fournit un accès programmatique à vos données de réunion, transcriptions, résumés et analyses générées par l’IA. Que vous construisiez des intégrations personnalisées, automatisiez des flux de travail ou vous connectiez à des outils comme Zapier, l’API vous donne le pouvoir d’étendre les capacités de Hedy au-delà de l’application. Toutes les fonctionnalités de l’API nécessitent un abonnement Pro avec Cloud Sync activé.

Pour commencer avec l’API

1. Ouvrez l’application Hedy et accédez à Account Settings

2. Faites défiler jusqu’à la section API Access

3. Cliquez sur Generate New API Key (abonnement Pro requis)

4. Copiez votre clé API et conservez-la en lieu sûr - vous ne pourrez plus la voir ensuite

5. Consultez notre documentation API sur SwaggerHub pour des informations détaillées sur les endpoints, ou accédez à la spécification OpenAPI brute sur https://api.hedy.bot/v1/docs

Note de sécurité : votre clé API fournit un accès complet à vos données Hedy. Conservez-la en sécurité et ne la partagez jamais publiquement ni ne la commitez dans le contrôle de version.

Capacités de l’API

L’API Hedy offre un accès complet à votre intelligence de réunion :

• Sessions : lister et récupérer vos sessions de réunion, y compris les transcriptions complètes, les résumés IA et les points clés

• Points clés : récupérer les moments importants de vos réunions avec les analyses générées par l’IA

• Sujets : créer, mettre à jour, supprimer et organiser les sessions par sujets avec des instructions de contexte personnalisées

• Tâches : récupérer et gérer les actions à mener à travers toutes les sessions

• Contextes de session : créer et gérer des instructions réutilisables qui guident la façon dont Hedy analyse vos réunions

• Webhooks : configurer et gérer les endpoints webhook via l’API pour des notifications d’événements en temps réel

• Informations utilisateur : récupérer les détails de votre compte via l’endpoint /me

Authentification

Toutes les requêtes API nécessitent une authentification avec votre clé API. Incluez-la dans l’en-tête Authorization :

Authorization: Bearer YOUR_API_KEY

Webhooks

Configurez des webhooks pour recevoir des notifications en temps réel lorsque des événements se produisent dans votre compte Hedy :

1. Dans la section API Access, cliquez sur Manage Webhooks

2. Cliquez sur le bouton + pour ajouter un nouveau webhook

3. Entrez l’URL de votre endpoint HTTPS

4. Sélectionnez les événements que vous souhaitez recevoir :

   • session.created - lorsqu’une nouvelle session d’enregistrement démarre

   • session.ended - lorsqu’une session d’enregistrement termine le traitement

   • session.exported - lorsqu’une session est exportée manuellement par l’utilisateur

   • highlight.created - lorsqu’un nouveau point clé est ajouté

   • todo.exported - lorsque les tâches sont exportées depuis une session

5. Enregistrez votre webhook et notez le secret de signature pour la vérification des charges utiles

Vous pouvez également gérer les webhooks de manière programmatique via l’API en utilisant GET, POST et DELETE sur l’endpoint /webhooks. Chaque compte peut avoir jusqu’à 50 webhooks.

Vérification de signature webhook

Chaque livraison de webhook inclut une signature dans l’en-tête X-Hedy-Signature pour que vous puissiez vérifier qu’elle provient de Hedy. La signature est un hash HMAC-SHA256 du corps brut de la requête, signé avec le secret de signature de votre webhook. Vérifiez la signature sur votre serveur avant de traiter la charge utile pour garantir l’authenticité. Chaque livraison inclut également un en-tête X-Hedy-Event indiquant le type d’événement (ex. session.ended).

Contextes de session

Les contextes de session vous permettent de créer des ensembles réutilisables d’instructions personnalisées qui indiquent à Hedy comment analyser vos réunions. Par exemple, vous pourriez créer un contexte pour les “Appels commerciaux” axé sur les actions à mener et les objections clients, ou un contexte pour les “Réunions standup” qui suit les blocages et les mises à jour.

Utilisez l’API pour gérer vos contextes de session :

• GET /contexts - lister tous vos contextes de session

• GET /contexts/{id} - obtenir un contexte spécifique par ID

• POST /contexts - créer un nouveau contexte (titre et contenu)

• PATCH /contexts/{id} - mettre à jour un contexte existant

• DELETE /contexts/{id} - supprimer un contexte

Définissez un contexte comme défaut et il s’appliquera automatiquement à toutes les nouvelles sessions. Les comptes du niveau gratuit sont limités à 1 contexte de session.

Gestion des sujets via l’API

Les sujets vous aident à organiser vos sessions par catégories. L’API prend en charge la gestion complète des sujets :

• GET /topics - lister tous les sujets avec les analyses générées par l’IA et le nombre de sessions

• GET /topics/{id} - obtenir les détails d’un sujet spécifique

• POST /topics - créer un nouveau sujet avec nom, description, couleur et icône

• PATCH /topics/{id} - mettre à jour les propriétés ou le contexte personnalisé d’un sujet

• DELETE /topics/{id} - supprimer un sujet (les sessions sont dissociées, pas supprimées)

• GET /topics/{id}/sessions - lister toutes les sessions d’un sujet

Les sujets peuvent inclure un champ topicContext avec des instructions personnalisées (jusqu’à 20 000 caractères) qui guident la façon dont Hedy analyse les sessions assignées à ce sujet.

Cas d’utilisation courants

• Intégration de gestion de projet : créer automatiquement des tâches dans votre outil de gestion de projet à partir des actions de réunion

• Gestion des connaissances : indexer le contenu des réunions dans la base de connaissances de votre entreprise

• Intégration CRM : mettre à jour les dossiers clients avec les analyses de réunion

• Tableaux de bord analytiques : créer des rapports personnalisés sur les modèles de réunion et la productivité

• Automatisation des flux de travail : déclencher des actions basées sur le contenu ou la fin d’une réunion

• Intégration Zapier : connecter Hedy à des milliers d’applications via Zapier (ajoutez ?format=zapier aux endpoints pour des réponses en tableau plat compatibles Zapier)

Limites et bonnes pratiques de l’API

• Limites de débit : 200 requêtes par minute par clé API

• Pagination : utilisez le paramètre limit (par défaut 50, max 100) et le paramètre de curseur after pour parcourir les résultats

• Mettez en cache les réponses lorsque c’est possible pour réduire les appels API

• Gérez les erreurs avec élégance avec un backoff exponentiel

• Utilisez les webhooks pour les mises à jour en temps réel au lieu du polling

Export automatique des tâches

Activez l’export automatique des tâches pour envoyer les actions à mener à vos systèmes intégrés :

1. Dans la section API Access, activez Auto Export Todos

2. Les tâches seront automatiquement envoyées à vos endpoints webhook configurés

3. Chaque tâche inclut le contexte, les suggestions d’assignation et la référence de réunion

Exemples de code

Voici un exemple simple pour obtenir vos sessions récentes :

curl -X GET "https://api.hedy.bot/v1/sessions?limit=10" \  -H "Authorization: Bearer YOUR_API_KEY"

Pour plus d’exemples et la référence complète des endpoints, consultez notre documentation API.

Dépannage

Erreur 401 Unauthorized

• Vérifiez que votre clé API est correcte et correctement formatée

• Assurez-vous d’avoir un abonnement Pro actif

• Vérifiez que Cloud Sync est activé dans votre compte

• Confirmez que la clé API n’a pas été régénérée (les anciennes clés sont invalidées)

Réponse vide ou données manquantes

• Assurez-vous que Cloud Sync est activé - l’API n’accède qu’aux données synchronisées dans le cloud

• Attendez quelques minutes après l’enregistrement pour que les données se synchronisent

• Vérifiez vos filtres de date et paramètres de pagination

• Vérifiez que vous utilisez le bon endpoint pour votre type de données

Le webhook ne reçoit pas d’événements

• Confirmez que l’URL de votre endpoint utilise HTTPS (obligatoire)

• Vérifiez que votre serveur répond avec un statut 200 OK

• Vérifiez l’en-tête X-Hedy-Signature si vous implémentez la vérification de signature

• Testez votre webhook en utilisant le bouton “Test Webhook”

• Vérifiez que les règles de pare-feu ne bloquent pas les serveurs de Hedy

Limite de débit dépassée

• Implémentez la mise en cache pour réduire les appels API redondants

• Utilisez les webhooks pour les mises à jour en temps réel au lieu du polling

• Regroupez les opérations lorsque c’est possible

• Contactez le support si vous avez besoin de limites plus élevées

Astuce Pro : utilisez les webhooks au lieu du polling pour les mises à jour en temps réel. C’est plus efficace et fournit des notifications instantanées lorsque vos données changent.

Confidentialité et sécurité

La sécurité de vos données est notre priorité :

• Toute la communication API utilise le chiffrement HTTPS

• Les clés API peuvent être régénérées à tout moment (invalide l’ancienne clé)

• Les charges utiles webhook sont signées avec HMAC-SHA256 pour la vérification

• Les données ne sont accessibles qu’avec une authentification valide

• Tous les endpoints appliquent des en-têtes de sécurité stricts

Obtenir de l’aide

Pour les questions spécifiques à l’API :

• Parcourez la documentation API pour les détails des endpoints et les schémas

• Lisez notre article de blog sur l’annonce de l’API pour des exemples et cas d’utilisation

• Rejoignez notre communauté Slack pour du support et pour partager vos intégrations