📖 Sommaire
Qu’est-ce qu’une clé API ?
Une clé API permet à votre application de s’authentifier auprès de l’API Yousign.
Elle identifie votre organisation et permet des échanges sécurisés de données, de documents et de services via des requêtes API.
Chaque clé API est définie par :
Un environnement (Sandbox ou Production)
Une étendue, qui détermine les ressources auxquelles la clé peut accéder
Un niveau de permission (Full-access ou Read-only)
Comment créer une clé API ?
Rendez-vous dans la section Développeurs du menu latéral gauche.
Cliquez sur Clés API.
S’il s’agit de votre première clé API, cliquez sur Commencer l’intégration (environnement Sandbox).
Sinon, cliquez sur Nouvelle clé API en haut de la page.
La création de votre première clé API démarre automatiquement votre période d’essai.
Vous devrez ensuite renseigner les informations suivantes :
1. Description
Saisissez un nom pour votre clé API.
Ce champ est facultatif, mais recommandé si vous prévoyez de créer plusieurs clés API. Utilisez une courte description pour identifier son usage (par exemple : « Intégration CRM – Production »).
2. Environnement
Choisissez l’environnement dans lequel la clé API sera utilisée :
Sandbox : environnement de test pour l’intégration API.
Sélectionnez-le si vous commencez votre intégration ou si vous n’avez pas encore de plan API payant.Production : environnement réel pour votre intégration.
Disponible uniquement si vous avez souscrit à un plan API.
3. Étendue
Définissez l’étendue de votre clé API.
L’étendue détermine l’ensemble des ressources accessibles via la clé.
Étendue organisation
La clé API peut accéder aux ressources de tous les workspaces de votre organisation.
Elle peut accéder à l’ensemble des données de l’organisation.
Adaptée aux intégrations globales ou plateformes centralisées.
Étendue workspace
La clé API peut accéder aux ressources uniquement dans les workspaces sélectionnés.
Vous devez sélectionner un ou plusieurs workspaces lors de la création.
Les ressources situées en dehors de ces workspaces ne sont pas accessibles.
La clé ne peut pas gérer les utilisateurs ni les workspaces.
L’étendue workspace permet d’isoler les données entre différentes équipes, projets ou clients finaux.
4. Niveau de permission
Choisissez le niveau de permission de la clé API :
Full-access : permet de créer et de modifier des ressources via des requêtes API.
Read-only : permet uniquement de consulter les informations via des requêtes API.
Une fois tous les champs renseignés, cliquez sur Créer une clé API.
Votre nouvelle clé apparaîtra dans la liste des clés API, où vous pourrez consulter :
l’environnement
le niveau de permission
l’étendue
Vous pouvez également utiliser les filtres et les options de navigation de la page Clés API pour retrouver rapidement une clé spécifique.
Combien de clés API puis-je créer ?
Vous pouvez créer jusqu’à 200 clés API actives par organisation.