📖 Sommaire
Pour commencer, qu’est-ce qu’une clé d’API ?
La clé d’API est essentielle pour le fonctionnement de l’API. Elle nous permet de vous identifier comme utilisateur ayant accès aux services API de Yousign, et sert donc de base à nos échanges de données, de documents et de services dans un cadre sécurisé.
Comment créer sa première clé API ?
Dans le menu API, cliquez sur la sous-catégorie “Clé API”.
Si c’est la première fois, cliquez sur “Commencer l’intégration” pour commencer en Sandbox, sinon cliquez sur le bouton en haut à gauche de votre écran “Nouvelle clé API”.
Cela enclenche automatiquement la période d’essai de l’API!
Vous avez 3 types d’informations à remplir pour créer votre clé API :
D’abord, dans “Description”, vous pouvez nommer votre clé API. Cette information est optionnelle pour la première clé, mais elle sera utile si vous créez plusieurs clés API. Nous vous recommandons donc de décrire très brièvement son contexte d’utilisation avec quelques mots clés qui vous permettront de l’identifier facilement.
Choisissez l’environnement dans lequel vous souhaitez créer votre clé API :
Sandbox : c’est l’environnement de test pour l’intégration de l’API. Si vous commencez l’intégration et vous n’avez pas encore de plan payant, c’est l’environnement que vous devrez choisir.
Production : c’est l’environnement dans lequel votre intégration est live. L’accès à cet environnement est limité aux utilisateurs qui ont déjà souscrit un plan API. Les tarifs: ici.
Puis, choisissez le niveau de permission pour la clé API :
Full-access : Vous pourrez créer ou mettre à jour des ressources avec les requêtes API à partir de cette clé.
Read-only : Vous pourrez uniquement lire les informations transmises avec les requêtes API à partir de cette clé.
Enfin, il suffit de cliquer sur “Créer une clé API” pour finaliser la clé.
Combien de clés API puis-je créer ?
Vous pouvez avoir jusqu'à 5 clés API actives en même temps dans votre organisation.