GitScrum
Testar grátis

Visão Geral da API

A API do GitScrum fornece acesso programático aos dados do seu workspace. Construa integrações personalizadas, automatize workflows, crie relatórios ou construa interfaces completamente novas em cima do GitScrum.

Começar

URL Base

https://services.gitscrum.com/v1

Autenticação

Todos os pedidos requerem uma chave API no cabeçalho:

Authorization: Bearer sua_chave_api_aqui

Gerar Chave API

  1. Vá a Definições de Workspace > API
  2. Clique "Gerar Chave API"
  3. Nomeie a chave descritivamente
  4. Copie imediatamente (mostrada apenas uma vez)
  5. Armazene com segurança

Limites de Taxa

PlanoPedidos/HoraBurst
Free1,000100/min
Pro10,000500/min
EnterprisePersonalizadoPersonalizado

Cabeçalhos de limite em cada resposta:

X-RateLimit-Limit: 10000
X-RateLimit-Remaining: 9847
X-RateLimit-Reset: 1705320000

Formato de Resposta

Todas as respostas são JSON:

{
  "data": { ... },
  "meta": {
    "page": 1,
    "per_page": 25,
    "total": 150
  }
}

Respostas de Erro

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Tarefa não encontrada",
    "details": { ... }
  }
}

Códigos de Estado HTTP

CódigoSignificado
200Sucesso
201Criado
400Pedido Inválido
401Não Autorizado
403Proibido
404Não Encontrado
422Erro de Validação
429Limite de Taxa
500Erro do Servidor

Endpoints Principais

Workspaces

GET    /workspaces              # Listar workspaces
GET    /workspaces/:id          # Obter detalhes
PUT    /workspaces/:id          # Atualizar

Projetos

GET    /workspaces/:id/projects         # Listar projetos
POST   /workspaces/:id/projects         # Criar projeto
GET    /projects/:id                     # Obter projeto
PUT    /projects/:id                     # Atualizar
DELETE /projects/:id                     # Eliminar

Tarefas

GET    /projects/:id/tasks      # Listar tarefas
POST   /projects/:id/tasks      # Criar tarefa
GET    /tasks/:id               # Obter tarefa
PUT    /tasks/:id               # Atualizar
DELETE /tasks/:id               # Eliminar
PATCH  /tasks/:id/move          # Mover tarefa

Membros da Equipa

GET    /workspaces/:id/members  # Listar membros
POST   /workspaces/:id/members  # Convidar
DELETE /members/:id             # Remover

Entradas de Tempo

GET    /tasks/:id/time-entries  # Listar tempo
POST   /time-entries            # Criar entrada
PUT    /time-entries/:id        # Atualizar
DELETE /time-entries/:id        # Eliminar

Sprints

GET    /projects/:id/sprints    # Listar sprints
POST   /projects/:id/sprints    # Criar sprint
PUT    /sprints/:id             # Atualizar
POST   /sprints/:id/start       # Iniciar
POST   /sprints/:id/end         # Terminar

Parâmetros de Query

Paginação

GET /projects/:id/tasks?page=2&per_page=50
  • page: Número da página (padrão: 1)
  • per_page: Itens por página (padrão: 25, max: 100)

Filtragem

GET /tasks?status=open&assignee=user_123&label=bug

Ordenação

GET /tasks?sort=created_at&order=desc

Incluir Relações

GET /tasks/:id?include=comments,time_entries,attachments

Webhooks

Registe webhooks para receber atualizações em tempo real:

POST /webhooks
{
  "url": "https://seu-servidor.com/webhook",
  "events": ["task.created", "task.updated"],
  "secret": "seu_segredo"
}

SDKs e Bibliotecas

Oficiais

  • JavaScript/TypeScript: npm install @gitscrum/sdk
  • Python: pip install gitscrum

OpenAPI Spec

Faça download da especificação OpenAPI:

GET /openapi.json

Melhores Práticas

Use Paginação

Nunca assuma que pode obter todos os itens. Sempre pagine.

Trate Limites de Taxa

Verifique X-RateLimit-Remaining e recue quando baixo.

Cache Quando Possível

Use cabeçalhos ETag para pedidos condicionais.

Proteja Suas Chaves

  • Nunca commite chaves para controlo de versão
  • Use variáveis de ambiente
  • Rode chaves periodicamente

Como Reportar um Problema ou Solicitar uma Funcionalidade

Se encontra problemas com a API ou precisa de endpoints adicionais, submeta feedback através do GitScrum Studio. Na Barra Lateral, clique em Tickets de Suporte e abra um ticket.

← Previous Next →