/azure-devops-kimai-api

Integração do Azure Devops com o Kimai 2

Primary LanguageTypeScriptGNU General Public License v3.0GPL-3.0

Azure Devops integration with Kimai

Autenticação e Credenciais

Para que sua API se comunique com o Azure DevOps e o Kimai, você precisará de credenciais.

Azure DevOps: A forma mais comum de autenticação para APIs é usando um Personal Access Token (PAT). No Azure DevOps, vá em User settings > Personal access tokens e crie um novo token. Dê a ele as permissões necessárias para ler os Work Items (geralmente, a permissão "Work Items" com "Read" é suficiente).

Kimai: O Kimai também usa tokens de API para acesso externo. Nas configurações de usuário do Kimai, você pode gerar um token de API.

Armazene essas credenciais de forma segura. O ideal é usar variáveis de ambiente em um arquivo .env para evitar que as credenciais fiquem expostas no código.

Integração com a API do Azure DevOps

Para buscar as tarefas (Work Items) do Azure DevOps, você usará a sua API REST. O NestJS usa o HttpModule para fazer requisições HTTP, que é um wrapper para o axios.

Observações Importantes

Mapeamento de Dados: A parte mais crítica da sua API será o mapeamento de dados. Você precisará definir como as informações de um Work Item (título, tempo gasto, etc.) se traduzirão em uma entrada de tempo no Kimai (projeto, atividade, duração).

Controle de Duplicidade: É essencial implementar uma lógica para evitar a criação de entradas duplicadas. Você pode, por exemplo, manter um registro em um banco de dados local ou usar algum identificador nos Work Items para marcar aqueles que já foram sincronizados.

Tratamento de Erros e Logs: Implemente um tratamento de erros robusto e utilize um sistema de logging para monitorar o status das requisições e diagnosticar problemas.