GitScrum / Docs

Visão Geral

Referência da API REST do GitScrum. Gerencie workspaces, projetos, tarefas, sprints, controle de tempo e mais via endpoints HTTP.

A API REST do GitScrum permite gerenciar programaticamente todo o seu fluxo de trabalho de gestão de projetos. Acesse workspaces, projetos, tarefas, sprints, controle de tempo, wiki, discussões e mais através de endpoints HTTP padrão.

URL Base

Todas as requisições à API utilizam a seguinte URL base:

https://services.gitscrum.com

Autenticação

Toda requisição requer um token Bearer no header Authorization:

Authorization: Bearer {token}

Consulte a página de Autenticação para detalhes sobre como obter e gerenciar tokens.

Formato de resposta

Todas as respostas retornam JSON com uma estrutura consistente:

{
  "data": { ... }
}

Endpoints paginados incluem metadados adicionais:

{
  "data": [ ... ],
  "meta": {
    "current_page": 1,
    "last_page": 5,
    "per_page": 20,
    "total": 97
  }
}

Recursos disponíveis

CategoriaDescrição
Workspaces e ProjetosGerencie workspaces, projetos, membros, workflows, labels
TarefasCrie, atualize, filtre, mova e complete tarefas
PlanejamentoSprints, user stories, épicos
ColaboraçãoPáginas wiki, discussões, notas, pesquisa, feeds de atividade
Tempo e OrçamentoControle de tempo, gerencie orçamentos, visualize análises
ClientFlow CRMClientes, faturas, propostas, painel
Análises e RelatóriosDashboards gerenciais, relatórios de standup

Limites de taxa

A API aplica limites de taxa para garantir uso justo. Consulte Limites de Taxa para cotas, headers de resposta e boas práticas.

Tratamento de erros

A API utiliza códigos de status HTTP padrão e retorna respostas de erro estruturadas. Consulte Tratamento de Erros para a referência completa.

Próximos passos