Avant de commencer
Vous pouvez créer des clés d'API pour des collaborateurs ou des utilisateurs robots. Il s'agit d'un code d'identification d'un utilisateur (ou développeur) utilisé pour accéder à nos APIs. Les clés d'API sont utilisées pour suivre et contrôler l'utilisation de l'API. La clé API sert à la fois d'identifiant unique et de jeton secret pour l'authentification et un ensemble de droits d'accès lui est associé.
Créer une nouvelle clé API
Pour créer une nouvelle clé API, vous devez vous rendre dans la roue de paramétrage > Clés API. Si vous n'avez pas les droits d'accès, contactez le support.
Cliquez sur Générer une nouvelle clé d'API pour créer une clé
Dans la fenêtre de création :
- Personnalisez éventuellement le nom que vous souhaitez associer à cette clé
- Sélectionnez les droits que vous souhaitez associer à cette clé
Options avancées : vous avez la possibilité de personnaliser la clef. Vous devez cependant respecter le format GUID (globally unique identifier), un identifiant unique d’une taille de 16 octets (exemple : {3F2504E0-4F89-11D3-9A0C-0305E82C3301}).
Une fois la clé générée, vous pouvez copier cette clé à son survol :
Modifier les droits associés à une clé existante
Si vous souhaitez modifier les droits associés à une clé, rendez-vous dans l’administration des rôles en cliquant sur le lien bleu « administration des rôles » :
Une fois la clé créée, vous pouvez utiliser nos APIs. Pour en savoir plus sur nos différentes APIs, nous vous invitons à consulter la documentation API.