Deseja criar um aplicativo que se integra com o ClickUp? Dê aos seus usuários a capacidade de fazer login usando o OAuth 2.0! Certifique-se também de verificar nossa documentação da API!
O que você vai precisar
- A API do ClickUp está disponível em todos os planos do ClickUp.
- Um proprietário ou administrador de um Workspace precisará criar um aplicativo em seu Workspace do ClickUp.
Fluxo do OAuth 2
Quando você deseja desenvolver um aplicativo que outros possam usar, é necessário usar um fluxo de autenticação OAuth2. Com o OAuth 2, cada pessoa que usa seu aplicativo recebe um token individualizado. Cada usuário só pode acessar o conteúdo disponível em sua conta de usuário individual do ClickUp.
Dica: Se você não estiver familiarizado com o OAuth2, a Digital Ocean compilou um ótimo guia que pode ajudá-lo a começar. Também recomendamos verificar o site do OAuth para obter detalhes adicionais.
Criar um aplicativo
O primeiro passo para usar o OAuth 2 é criar um aplicativo em seu Workspace. Você deve ser proprietário ou administrador de um Workspace para gerenciar as configurações de integração. Para fazer isso:
- Abra suas configurações pessoais:
- ClickUp 2.0: No canto inferior esquerdo, clique em seu avatar. Selecione “Minhas configurações”.
- ClickUp 3.0: No canto superior direito, clique em seu avatar. Selecione “Minhas configurações”.
- Na barra lateral, clique em “ClickUp API”.
- Clique em “+ Criar um Aplicativo”.
- Digite o nome do seu aplicativo e uma URL de redirecionamento.
- Dica: Não tem certeza do que usar para a URL de redirecionamento? Confira este guia no site do OAuth.
- Clique em “Criar Aplicativo”.
- Na próxima tela, você verá que um Cliente ID e um Cliente Secret foram gerados.
- Use o Cliente ID e o Cliente Secret em seu aplicativo para criar um fluxo de autenticação OAuth 2.
Atualize suas URLs de redirecionamento
Tem uma nova URL de redirecionamento? Você pode atualizar essas configurações em seu Workspace do ClickUp a qualquer momento.
- Clique em seu avatar do Workspace.
- Selecione “Integrações”.
- Clique em “ClickUp API”.
- Expanda o aplicativo para mostrar seus detalhes.
- Atualize seu aplicativo:
- Adicione ou atualize as URLs de redirecionamento.
- Clique em “Salvar”.
Visualize ou regenere seu segredo do cliente
Deseja regenerar seu Cliente Secret? Você pode fazer isso a qualquer momento.
- Clique em seu avatar do Workspace.
- Selecione “Integrações”.
- Clique em “ClickUp API”.
- Expanda o aplicativo para mostrar seus detalhes.
- Clique em “Mostrar” para visualizar seu Cliente Secret atual.
- Clique em “Regenerar” para criar imediatamente um novo Cliente Secret.
- Atualize seu aplicativo para usar o novo Cliente Secret.
Tipos de token de autorização
Os tokens permitem que você faça chamadas à API e se integre com outras aplicações. Você também pode usar aplicativos como o Make para criar integrações sem escrever código. Os tokens são específicos para sua conta de usuário do ClickUp.
Qualquer pessoa com uma conta do ClickUp pode gerar um token pessoal. Os tokens pessoais permitem acesso a todos os Workspaces que sua conta criou ou aos quais se juntou. Seu token pessoal concede a você o mesmo acesso que você tem por meio de um navegador da web.
Se você usar o OAuth2, poderá escolher autorizar o acesso a Workspaces específicos quando autenticar pela primeira vez ou quando reautenticar posteriormente.