Vous avez besoin d’une clé API pour authentifier la plupart des requêtes faites à l’API REST de Universign. Une clé API est un identifiant unique associé à votre compte. Elle est nécessaire pour des raisons d’utilisation et de facturation. Seuls les utilisateurs avec des droits d’administrateur peuvent créer des clés API.
Créer votre clé API
Depuis l’espace Développeur de votre espace de travail, accédez à la section Clés API et cliquez sur Créer une clé API.
Notez que vous pouvez avoir jusqu’à 5 clés API par espace de travail.
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, 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".
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.
