Quer criar um aplicativo que se integre ao ClickUp? Dê aos seus usuários a possibilidade de fazer login usando OAuth 2.0!

Não deixe de conferir nossa documentação da API!

O que você vai precisar

• A API do ClickUp está disponível em todos os planos do ClickUp.
• Proprietários ou administradores do Espaço de trabalho podem gerenciar as configurações de integração e criar aplicativos OAuth no Espaço de trabalho.
• Membros e membros limitados com permissões de edição completa podem usar tokens pessoais de API.
• Membros limitados com permissões somente de visualização não podem acessar nem gerenciar a API.

Fluxo OAuth 2

Quando você quer desenvolver um aplicativo que outras pessoas possam usar, é preciso utilizar um fluxo de autenticação OAuth2.

Com o OAuth 2, todos que usam seu aplicativo recebem um token individualizado. Cada usuário pode acessar apenas o conteúdo disponível para sua conta de usuário individual no ClickUp.

Se você não está familiarizado com OAuth2, a Digital Ocean publicou um excelente guia para ajudá-lo a começar. Também recomendamos consultar o site do OAuth para mais detalhes.

Criar um aplicativo

O primeiro passo para usar o OAuth 2 é criar um aplicativo no seu Espaço de trabalho. Você precisa ser proprietário ou administrador do Espaço de trabalho para gerenciar as configurações de integração.

Para criar um aplicativo no seu Espaço de trabalho:

1. No canto superior esquerdo, clique no avatar do seu Espaço de trabalho.
2. Selecione Configurações.
3. Na barra lateral Todas as configurações, selecione ClickUp API.
4. No canto superior direito da página Configurações da ClickUp API, clique em Criar um aplicativo.

   

5. Insira o nome do seu aplicativo e uma ou mais URLs de redirecionamento. Se não souber qual URL usar, consulte o guia de URLs de redirecionamento no site do OAuth.
6. Clique em Criar aplicativo.
7. Na tela seguinte, você verá que um ID do cliente e um Segredo do cliente foram gerados.
8. Use o ID do cliente e o Segredo do cliente no seu aplicativo para criar um fluxo de autenticação OAuth 2.

Atualizar suas URLs de redirecionamento

Se você tiver uma nova URL de redirecionamento, pode atualizar essas configurações no seu Espaço de trabalho do ClickUp a qualquer momento:

1. No canto superior esquerdo, clique no avatar do seu Espaço de trabalho.
2. Selecione Configurações.
3. Na barra lateral Todas as configurações, selecione ClickUp API.
4. Clique em um aplicativo existente para expandir seus detalhes.
5. Atualize a URL de redirecionamento.
6. Clique em Salvar.

Visualizar ou regenerar seu segredo do cliente

Para regenerar seu segredo do cliente:

1. No canto superior esquerdo, clique no avatar do seu Espaço de trabalho.
2. Selecione Configurações.
3. Na barra lateral Todas as configurações, selecione ClickUp API.
4. Clique em um aplicativo existente para expandir seus detalhes.
5. Clique em Mostrar para ver seu Segredo do cliente atual.
6. Clique em Regenerar para criar um novo Segredo do cliente.
7. Atualize seu aplicativo para usar o novo Segredo do cliente.

Tipos de token de autorização

Os tokens permitem que você faça chamadas de API e se integre a outros aplicativos. 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 no ClickUp pode gerar um token pessoal. Os tokens pessoais permitem acesso a todos os Espaços de trabalho que sua conta criou ou dos quais participou. Seu token pessoal concede o mesmo acesso que você tem pelo navegador.

Se você usar OAuth2, pode optar por autorizar o acesso a Espaços de trabalho específicos na primeira autenticação ou ao se autenticar novamente mais tarde.