Vous avez besoin d’une clé API Master Console pour authentifier les requêtes de création et de configuration de vos espaces de travail par API. Une clé API est un identifiant unique associé à votre compte. Elle est nécessaire pour des raisons d’utilisation et de facturation.
Créer votre clé API Master Console
Vous pouvez accéder à la rubrique Clés API à partir du menu latéral gauche de votre Master Console.
Notez que vous pouvez avoir jusqu’à 5 clés API par Master Console.
Si vous supprimez une clé API, vous ne pourrez plus l’utiliser pour authentifier vos requêtes.
Recommandations
- Nommez explicitement votre clé API. Il vous sera plus facile d’identifier quelle clé API peut être supprimée, par exemple.
- Copiez votre clé API et stockez-la dans un endroit sécurisé de votre côté. Pour des raisons de sécurité, Universign ne stocke pas les clés API en texte clair.
Authentifier votre requête
Une fois que vous avez créé votre clé API Master Console, vous êtes prêt à authentifier votre requête. Ajoutez-la à l’en-tête de la requête en tant que valeur du nom d’utilisateur suivie de deux-points : -u your_API_key: (le champ mot de passe peut être laissé vide).
Alternativement, vous pouvez vous authentifier via bearer auth : -H "Authorization: Bearer your_API_key".
Notez qu’une clé API Master Console ne peut être utilisée pour authentifier les requêtes de transaction, cachet, horodatage, etc.
Erreurs d’authentification
Si vous ne fournissez pas de clé API ou si vous en fournissez une invalide lorsque l’authentification est requise, vous recevrez une réponse 401 - Unauthorized.
Si la clé API que vous avez fournie ne vous donne pas accès à la ressource, vous recevrez une réponse 403 - Forbidden.
