API e integrações
Este capítulo mostra como conectar a plataforma a outros sistemas: gerar uma chave de acesso, consultar a documentação da API e ativar as integrações disponíveis.
Acesse pelo menu lateral, em Integrações.
A página reúne quatro cartões:
- Google Workspace, para entrar na plataforma com a conta institucional do Google.
- Sincronização de Calendário, tratada no capítulo sobre Calendário e Gantt.
- Alertas por E-mail, que controla os avisos enviados para a caixa de correio.
- API de Exportação (REST), assunto do restante deste capítulo.
Gerar uma chave de API
A chave é o que permite a um sistema externo, como uma ferramenta de BI, ler os dados da plataforma.
- No cartão API de Exportação (REST), clique em Gerar Nova Chave API.
- Copie a chave exibida e guarde em local seguro.
Atenção A chave aparece uma única vez, no momento em que é gerada. Depois disso a plataforma mostra apenas que existe uma chave ativa, sem repetir o texto. Se você perder a chave, gere outra.
Gerar uma chave nova invalida a anterior. Para encerrar o acesso sem criar outra, clique em Revogar.
Atenção A chave carrega as mesmas permissões da sua conta. Trate-a como uma senha: não compartilhe por e-mail ou mensagem, e revogue assim que a integração deixar de ser usada.
Documentação da API
Clique em Ver Documentação da API (Swagger) para abrir a referência interativa dos endpoints.
Cada grupo pode ser aberto para ver os endpoints, os parâmetros aceitos e o formato da resposta. O campo Filter by tag ajuda a encontrar um grupo específico.
O botão Authorize, no canto direito, guarda sua chave no navegador e permite testar chamadas direto na página, pelo botão Try it out de cada endpoint.
Atenção O teste pela documentação executa a chamada de verdade, contra os dados reais da plataforma. Endpoints de criação, alteração e exclusão vão alterar dados. Ao explorar, prefira os endpoints de leitura.
Para uma leitura corrida, com exemplos e a tabela de erros, clique em Guia, no topo da documentação.
O guia cobre autenticação, permissões, os objetos retornados por cada recurso (projetos, tarefas, timesheet, especialistas e unidades organizacionais), os códigos de erro e um exemplo pronto de chamada.
Permissão O item Integrações aparece no menu lateral para Admin, Super Admin e Coordenador. Gerar uma chave de API exige a permissão de gerir integrações, concedida a esses três por padrão. Revogar uma chave existente continua livre para qualquer pessoa autenticada, é a sua própria chave.