Acesso à API do Projeto

A aba API exibe as credenciais de API do seu projeto para acesso programático e fornece visibilidade sobre o uso da API através de estatísticas de rate limit, gráficos de uso e histórico de requisições recentes. Use estas credenciais para integrar o GitScrum com ferramentas externas, scripts de automação e aplicações personalizadas.

Visão Geral

A interface exibe informações de uso da API em tempo real organizadas em três seções principais: estatísticas de rate limit no topo, um gráfico de uso mostrando requisições dos últimos 7 dias, e uma tabela de requisições recentes feitas ao seu projeto.

Seção de Rate Limits

A seção de rate limits exibe três cards de estatísticas mostrando o status atual de uso da API:

Total de Requisições

Mostra o número total de requisições de API permitidas durante o período de faturamento atual. Se seu plano inclui requisições ilimitadas, exibe "Ilimitado" ao invés de um número.

Disponível

Exibe quantas requisições restam disponíveis para o período atual. Um número verde indica disponibilidade saudável. Quando seu plano é ilimitado, também mostra "Ilimitado".

Período

Mostra o intervalo de datas do período de faturamento atual no formato "início → fim" (ex: "1 Dez → 31 Dez"). Isso ajuda você a entender quando seu contador de requisições é reiniciado.

Gráfico de Uso

Um gráfico de barras exibe o volume de requisições de API nos últimos 7 dias. Cada barra representa um dia, com a altura indicando o número de requisições feitas naquele dia. O gráfico usa um esquema de cores azul com:

• Eixo X mostrando datas em formato curto
• Eixo Y mostrando contagem de requisições
• Efeitos hover destacando barras individuais
• Estado vazio mostrando barras planas quando nenhuma requisição foi feita

Esta visualização ajuda a identificar padrões de uso e detectar picos incomuns na atividade da API.

Tabela de Requisições Recentes

Quando requisições de API foram feitas ao seu projeto, uma tabela exibe a atividade mais recente com as seguintes colunas:

Método

Mostra o método HTTP usado para cada requisição com badges coloridos:

• GET - Badge verde para operações de leitura
• POST - Badge azul para operações de criação
• PUT - Badge laranja para operações de atualização
• DELETE - Badge vermelho para operações de exclusão

Endpoint

Exibe o caminho do endpoint da API que foi chamado. Endpoints longos são truncados com reticências.

Tempo

Mostra quando a requisição foi feita usando tempo relativo legível (ex: "2m atrás", "1h atrás", "Ontem"). Passe o mouse sobre o tempo para ver o timestamp exato.

Credenciais da API

Clique no botão Obter Credenciais no cabeçalho para abrir o modal de credenciais. Este modal fornece as chaves de autenticação necessárias para acessar seu projeto via API.

API ID

Um identificador único para acesso à API. Este valor é somente leitura e não pode ser alterado. Clique no ícone de cópia para copiar para sua área de transferência. Uma confirmação "Copiado" aparece brevemente após copiar.

Project Key

A chave específica do projeto usada para autenticação. Esta também é somente leitura. Clique no ícone de cópia para copiar para sua área de transferência.

Regenerando Credenciais

Se suas credenciais forem comprometidas ou você precisar rotacioná-las por segurança:

1. Clique no botão Regenerar na parte inferior do modal
2. O sistema gera novos valores de API ID e Project Key
3. Atualize imediatamente quaisquer aplicações usando as credenciais antigas
4. Credenciais antigas param de funcionar assim que as novas são geradas

Aviso: Regenerar credenciais invalida todas as integrações existentes usando os valores antigos. Planeje sua rotação de credenciais cuidadosamente.

Documentação da API

Clique no link Ver documentação na parte inferior do modal de credenciais para abrir a documentação completa da API em gitscrum.com. A documentação fornece:

• Referência completa de endpoints
• Detalhes de autenticação
• Exemplos de requisição e resposta
• Explicações de códigos de erro

Entendendo Rate Limits

Rate limits protegem a API contra abuso e garantem uso justo entre todos os usuários. Seu plano determina seus limites:

• Limites são calculados por período de faturamento
• O contador Disponível diminui conforme você faz requisições
• O contador reinicia no início de cada novo período
• Planos ilimitados mostram "Ilimitado" para total e disponível

Monitorando a Saúde da API

Use a aba API regularmente para:

1. Verificar cota restante - Garantir que você tem requisições suficientes disponíveis
2. Revisar padrões de uso - O gráfico revela tendências de uso diário
3. Auditar atividade recente - A tabela de requisições mostra quais endpoints estão sendo chamados
4. Detectar anomalias - Picos incomuns podem indicar problemas de integração ou acesso não autorizado

Permissões

Acesso às credenciais e estatísticas da API requer permissões de Admin ou Manager do projeto. Membros da equipe com permissões menores não podem visualizar esta aba.

Funcionalidades Relacionadas

• Webhooks - Receba notificações em tempo real quando eventos ocorrem
• Integrações - Conecte com Slack, Discord, GitHub e outros serviços