Vous souhaitez créer une application qui s'intègre à ClickUp ? Offrez à vos utilisateurs la possibilité de se connecter via OAuth 2.0 !
N'oubliez pas de consulter notre documentation API !
Ce dont vous aurez besoin
- L'API ClickUp est disponible sur tous les abonnements ClickUp.
- Les propriétaires ou administrateurs d'un Environnement de travail peuvent gérer les paramètres d'intégration et créer des applications OAuth dans l'Environnement de travail.
- Les membres et membres limités disposant de permissions de modification complètes peuvent utiliser des jetons API personnels.
- Les membres limités disposant uniquement de permissions de consultation ne peuvent pas accéder à l'API ni la gérer.
Flux OAuth 2
Pour développer une application que d'autres personnes pourront utiliser, vous devez mettre en place un flux d'authentification OAuth2.
Avec OAuth 2, chaque utilisateur de votre application se voit attribuer un jeton individualisé. Chaque utilisateur ne peut accéder qu'au contenu disponible dans son compte utilisateur ClickUp.
Si vous n'êtes pas familier avec OAuth2, Digital Ocean a rédigé un excellent guide pour vous aider à démarrer. Nous vous recommandons également de consulter le site web d'OAuth pour plus de détails.
Créer une application
La première étape pour utiliser OAuth 2 consiste à créer une application dans votre Environnement de travail. Vous devez être propriétaire ou administrateur de l'Environnement de travail pour gérer les paramètres d'intégration.
Pour créer une application dans votre Environnement de travail :
- Dans le coin supérieur gauche, cliquez sur l'avatar de votre Environnement de travail.
- Sélectionnez Paramètres.
- Dans la barre latérale Tous les paramètres, sélectionnez API ClickUp.
- Dans le coin supérieur droit de la page Paramètres de l'API ClickUp, cliquez sur Créer une application.
- Saisissez le nom de votre application ainsi qu'une ou plusieurs URL de redirection. Si vous ne savez pas quelle URL de redirection utiliser, consultez le guide sur les URL de redirection disponible sur le site web d'OAuth.
- Cliquez sur Créer une application.
- Sur l'écran suivant, vous verrez qu'un identifiant client et un secret client ont été générés.
- Utilisez l'identifiant client et le secret client dans votre application pour créer un flux d'authentification OAuth 2.
Mettre à jour vos URL de redirection
Si vous avez une nouvelle URL de redirection, vous pouvez mettre à jour ces paramètres dans votre Environnement de travail ClickUp à tout moment :
- Dans le coin supérieur gauche, cliquez sur l'avatar de votre Environnement de travail.
- Sélectionnez Paramètres.
- Dans la barre latérale Tous les paramètres, sélectionnez API ClickUp.
- Cliquez sur une application existante pour afficher ses détails.
- Mettez à jour l'URL de redirection.
- Cliquez sur Enregistrer.
Afficher ou régénérer votre secret client
Pour régénérer votre secret client :
- Dans le coin supérieur gauche, cliquez sur l'avatar de votre Environnement de travail.
- Sélectionnez Paramètres.
- Dans la barre latérale Tous les paramètres, sélectionnez API ClickUp.
- Cliquez sur une application existante pour afficher ses détails.
- Cliquez sur Afficher pour consulter votre secret client actuel.
- Cliquez sur Régénérer pour créer un nouveau secret client.
- Mettez à jour votre application pour utiliser le nouveau secret client.
Types de jetons d'autorisation
Les jetons vous permettent d'effectuer des appels API et de vous intégrer à d'autres applications. Vous pouvez également utiliser des applications comme Make pour créer des intégrations sans écrire de code. Les jetons sont propres à votre compte utilisateur ClickUp.
Toute personne disposant d'un compte ClickUp peut générer un jeton personnel. Les jetons personnels donnent accès à tous les Environnements de travail que votre compte a créés ou rejoints. Votre jeton personnel vous accorde le même niveau d'accès que celui dont vous disposez via un navigateur web.
Si vous utilisez OAuth2, vous pouvez choisir d'autoriser l'accès à des Environnements de travail spécifiques lors de votre première authentification ou lors d'une authentification ultérieure.