Les clés d'API

Donner un accès programmatique, limité à ce que vous décidez.

Une clé d'API permet à un script, un outil ou un assistant d'accéder à OIO en votre nom. Elle se crée depuis Profil › Clés d'API.

Ce qu'une clé porte comme limites

Une clé n'est jamais un accès général à votre compte. Trois restrictions se cumulent.

Un espace, et un seul. Toute clé est rattachée à un espace au moment de sa création. Elle ne verra jamais rien des autres, même s'ils vous appartiennent.

Des pages précises, si vous le voulez. Par défaut la clé accède à tout l'espace. Vous pouvez la restreindre à certaines pages : elle ne verra alors que celles-ci et leurs sous-pages.

Lecture seule ou lecture-écriture. Une clé en lecture seule ne peut rien créer, rien modifier, rien supprimer — pas même déposer un commentaire — quels que soient vos propres droits dans l'espace.

Ces limites sont appliquées par le serveur à chaque requête. Ce ne sont pas des réglages d'affichage.

Créer une clé

Choisissez un libellé qui vous parlera dans six mois (« Export comptable », « Assistant »), l'espace, le niveau d'accès, et éventuellement les pages autorisées.

La clé n'est affichée qu'une seule fois, au moment de sa création. Personne, pas même vous, ne peut la retrouver ensuite. Copiez-la immédiatement.

Suivre et révoquer

La liste des clés indique pour chacune son espace, son niveau d'accès et sa date de dernière utilisation — utile pour repérer une clé oubliée, ou vérifier qu'une clé que vous croyez inutilisée l'est vraiment.

Révoquer une clé la désactive immédiatement et définitivement. Si une clé a pu être vue par quelqu'un d'autre, révoquez-la : c'est instantané et sans conséquence sur les contenus.

Bonnes habitudes

  • Une clé par usage, plutôt qu'une clé partagée entre plusieurs outils.
  • La lecture seule par défaut ; l'écriture uniquement quand elle est indispensable.
  • Une clé restreinte à quelques pages quand l'outil n'a pas besoin de tout l'espace.
  • Une clé ne se met ni dans un dépôt de code, ni dans un message.

Confirmation