Créer et gérer des clés API
Créer une clé pour l'API publique, choisir ses portées et son expiration, la restreindre par adresse IP, puis la révoquer.
Une clé API permet à vos outils d’appeler l’API publique d’Upsellr au nom de votre organisation. L’accès à l’API est réservé à l’offre Enterprise.
Où trouver les clés
Ouvrez le menu du compte, puis Gérer et API et webhooks. Sur une autre offre que Enterprise, la section affiche « Réservé à l’offre Enterprise » et un bouton pour changer d’offre.
Créer une clé
- Cliquez sur Créer une clé API.
- Donnez-lui un Nom qui dit à quoi elle sert, par exemple le nom de l’outil qui l’utilise.
- Choisissez un Préréglage de portées :
- Lecture seule : lire les canaux, produits, sources, workflows, membres et l’organisation.
- Lecture et écriture : tout, sauf lancer des workflows.
- Accès complet : toutes les portées, y compris lancer des workflows.
- Personnalisé : cochez une à une les portées voulues.
- Choisissez l’Expiration : 7 jours, 30 jours, 90 jours, 1 an, 3 ans, Pas d’expiration, ou une durée personnalisée de 1 à 1 095 jours.
- Si besoin, renseignez les IP autorisées et les User-Agents autorisés, séparés par des virgules.
- Cliquez sur Créer la clé.
La clé s’affiche une seule fois. Copiez-la et conservez-la en lieu sûr avant de fermer la fenêtre.
Les portées disponibles
| Ressource | Portées |
|---|---|
| Canaux | Créer, lire, modifier, supprimer |
| Produits | Créer, lire, modifier, supprimer |
| Sources | Lire, déposer des fichiers sources |
| Workflows | Lire, lancer |
| Organisation | Lire l’organisation, lire les membres |
Révoquer une clé
Dans la liste, cliquez sur Révoquer à côté de la clé. Toute intégration qui l’utilise cesse de fonctionner immédiatement. Cette action est irréversible.
Bon à savoir
- Seuls les propriétaires et les administrateurs créent et révoquent les clés. Les membres les voient en lecture seule.
- La liste affiche pour chaque clé ses portées, sa date d’expiration et sa Dernière utilisation : une clé jamais utilisée est souvent une clé à révoquer.
- Lancer un workflow peut engager beaucoup de produits et de crédits. Ne donnez la portée de lancement qu’aux intégrations qui en ont besoin.
- Créez une clé par intégration, avec les seules portées nécessaires.
- Une clé perdue ne peut pas être réaffichée : révoquez-la et créez-en une nouvelle.