Aller au contenu principal

Clés API

Retyc expose une API publique qui permet d'intégrer vos outils (scripts, supervision, SIRH, GED...) avec votre organisation : consultation des membres, des transferts et des datarooms, automatisations. L'accès se fait par des clés API propres à l'organisation.

Réservé aux Owner et Admin.

Page Clés API

Créer une clé

  1. Accédez à Dashboard > Organisation > Clés API
  2. Donnez un nom à la clé (ex. : "Monitoring")
  3. Choisissez sa durée de validité : la clé expire automatiquement
  4. Cochez les scopes à accorder
  5. Cliquez sur Créer la clé

Le secret de la clé est affiché une seule fois à la création : copiez-le immédiatement dans votre gestionnaire de secrets.

Les scopes

Chaque clé est limitée aux permissions que vous sélectionnez :

ScopeAccès
organization:readLire les informations et membres de l'organisation
organization:writeModifier l'organisation
transfer:readLire les transferts
transfer:writeGérer les transferts
dataroom:readLire les datarooms
dataroom:writeGérer les datarooms

Accordez uniquement les scopes nécessaires à chaque usage : une clé de supervision n'a besoin que de scopes read.

Restriction par IP

En bas de la page, vous pouvez restreindre l'utilisation des clés API à une liste d'adresses IP autorisées. Activez l'option Restreindre les clés API aux IP autorisées, puis collez votre liste d'adresses. Une clé utilisée depuis une IP non listée est refusée.

Révoquer une clé

La section Clés existantes liste les clés actives avec leur expiration. Supprimez une clé pour révoquer immédiatement son accès.

Documentation de l'API

La référence complète de l'API publique (endpoints, schémas, authentification) est accessible via le bouton Documentation en haut de la page Clés API.

info

L'API publique ne peut pas déchiffrer vos fichiers : le chiffrement de bout en bout s'applique aussi aux intégrations. Les clés API donnent accès aux métadonnées et aux opérations de gestion, jamais au contenu en clair.