Clés API et périmètres

Une clé API permet à un script ou à un autre système d'appeler l'API xEvolve sans connexion à la console. Chaque clé porte des périmètres qui limitent ce qu'elle peut faire.

Créer une clé

Ouvrez Clés API et choisissez Nouvelle clé.
Saisissez un nom, cochez les périmètres nécessaires et définissez éventuellement une expiration en jours.
Copiez la clé. Elle commence par xev_ et n'est affichée qu'une fois. xEvolve ne conserve qu'un hachage.

Envoyez la clé comme jeton bearer à votre espace :

curl https://<workspace>.xevolve.io/api/v1/connections \
  -H "Authorization: Bearer xev_<key>"

La révocation d'une clé prend effet immédiatement. La création et la révocation de clés sont écrites dans le journal d'audit.

Règles

Une clé ne peut créer que des clés dont les périmètres figurent parmi les siens. Demander davantage renvoie 403.
Un appel sans le périmètre requis renvoie 403 avec API key missing required scope.
Une session de console n'est pas limitée par les périmètres ; elle suit le rôle de l'utilisateur.
Les réglages d'authentification multifacteur, la gestion des sessions, les événements de connexion, l'enregistrement des principaux de service, les avatars, la politique de conservation et l'état de l'essai n'acceptent que les sessions de console. Les clés API reçoivent 403.

Périmètres

Périmètre	Autorise
`files:read`	Lister, rechercher et télécharger des fichiers.
`files:write`	Téléverser des fichiers.
`transfers:read`	Lister et consulter les transferts.
`transfers:write`	Créer, exécuter et annuler des transferts.
`connections:read`	Lister et consulter les connexions.
`connections:write`	Créer, modifier, supprimer et tester des connexions.
`data-rooms:read`	Lister et consulter les salles de données.
`data-rooms:write`	Créer, modifier et gérer les salles de données.
`schedules:read`	Lister les planifications et l'historique d'exécution.
`schedules:write`	Créer, modifier, supprimer et exécuter des planifications.
`watchers:read`	Lister les surveillances de dossier.
`watchers:write`	Créer, modifier et supprimer des surveillances.
`workflows:read`	Lister les workflows et l'historique d'exécution.
`workflows:write`	Créer, modifier, supprimer et exécuter des workflows.
`parameters:read`	Lister et consulter les paramètres globaux.
`parameters:write`	Créer, modifier et supprimer des paramètres globaux.
`users:read`	Lister et consulter les utilisateurs.
`users:write`	Modifier et supprimer des utilisateurs.
`agents:read`	Lister et consulter les agents gérés.
`agents:write`	Créer, modifier, supprimer et tester des agents gérés.
`webhooks:read`	Lister les webhooks et les livraisons.
`webhooks:write`	Créer, modifier et supprimer des webhooks.
`activity:read`	Lire le journal d'activité et les compteurs du tableau de bord.
`notifications:read`	Lire les réglages de notification et le journal des notifications.
`notifications:write`	Modifier ou tester les réglages de notification.
`api-keys:read`	Lister les clés API.
`api-keys:write`	Créer et révoquer des clés API, dans les périmètres que détient la clé appelante.

Les clés API et les webhooks nécessitent l'offre Team ou supérieure. Offres et limites indique les requêtes API autorisées par mois.