Documentation développeur

Sécurité et données

Gérez les clés API et les autorisations en toute sécurité, et vérifiez les notes accessibles à chaque intégration.

Gestion des clés API

  • Les clés API (alt_live_...) ne sont affichées qu'une seule fois, à leur création. Nous n'en stockons qu'un hachage à clé (keyed hash) : elles ne peuvent donc jamais être réaffichées — en cas de perte, vous devez procéder à une rotation.
  • Les secrets de signature des webhooks (whsec_...) ne sont eux aussi affichés qu'une seule fois. Ils sont stockés chiffrés (AES-256-GCM) et déchiffrés uniquement pour signer les livraisons sortantes — jamais réaffichés. Pour en changer, recréez l'endpoint : un nouveau secret est alors émis.
  • Conservez vos clés dans un gestionnaire de secrets. Ne les intégrez jamais à du code côté client, à des applications mobiles ou à des dépôts.
  • Effectuez la rotation depuis la console : émettez une nouvelle clé sur la même intégration, basculez vos systèmes, puis révoquez l'ancienne. La révocation prend effet immédiatement.
  • Vous pouvez éventuellement définir une expiration à la création d'une clé ; les clés expirées sont automatiquement rejetées.
  • Une clé par système. Séparez la préproduction de la production pour qu'une révocation d'un côté n'interrompe pas l'autre.
  • Il n'existe ni sandbox ni mode test : chaque clé émise est une clé de production et lit de vraies notes. Utilisez des intégrations distinctes pour la préproduction et la production ; et pour éprouver un récepteur sans attendre un enregistrement réel, appuyez-vous sur l'événement de vérification envoyé à la création d'un endpoint, ou sur « Envoyer un test » dans la console.

Données accessibles par intégration

  • Une intégration personnelle ne voit que les notes personnelles de son propriétaire. Une intégration espace d'équipe ne voit que les notes partagées dans cet espace d'équipe — jamais les notes personnelles des membres.
  • Seul le propriétaire d'un espace d'équipe peut créer des intégrations pour cet espace.
  • Les notes hors du périmètre de vos identifiants renvoient 404 — l'API ne révèle pas si elles existent.
  • Lorsqu'une note sort de votre périmètre, vous recevez note.deleted (reason: access_lost) et la note disparaît de vos listes. Supprimez votre copie ou bloquez-y l'accès.

Autorisations (scopes)

AutorisationDroits accordés
notes:readLister les notes et lire leurs métadonnées.
transcripts:readLire le texte des transcriptions et les segments par locuteur.
summaries:readLire les résumés (Markdown).
webhooks:manageCréer, modifier, supprimer et tester des endpoints de webhooks via l'API publique.

N’accordez que les autorisations nécessaires à l’intégration. Une requête exigeant une autorisation absente de la clé API échoue avec 403 insufficient_scope.

Limites de requêtes API

  • 120 requêtes par minute et par clé. Au-delà, l'API renvoie 429 rate_limited avec un en-tête Retry-After — patientez au moins ce délai avant de réessayer.
  • Privilégiez les webhooks et la synchronisation incrémentale (updated_after) plutôt que des boucles de polling serrées.
  • Utilisez ETag / If-None-Match lors de la lecture des notes, des transcriptions et des résumés — les réponses 304 coûtent moins cher à tout le monde.

Confidentialité

  • Les transcriptions et les résumés sont du contenu utilisateur et peuvent contenir des données personnelles. Ne récupérez que ce dont votre intégration a besoin et protégez ce que vous stockez.
  • Respectez les suppressions : à la réception d'un note.deleted (quelle qu'en soit la raison), supprimez votre copie ou bloquez-y l'accès. Effectuez périodiquement une réconciliation au cas où vous auriez manqué l'événement.
  • Les URL de webhook doivent être des endpoints HTTPS publics. Les adresses privées, de loopback et de métadonnées cloud sont rejetées, et les redirections ne sont pas suivies.
  • L'accès à l'API nécessite un abonnement actif sur l'espace de travail de l'intégration ; sans abonnement, les requêtes échouent avec 403 plan_required.
  • Consultez notre Politique de confidentialité pour savoir comment Alt traite les données de ses utilisateurs.