GitScrum / Docs

Démarrage Rapide

Démarrez avec l'API GitScrum en 5 minutes. Listez les workspaces, récupérez les projets et créez votre première tâche.

REST API — Tous les endpoints nécessitent une authentification par Bearer token. Incluez Authorization: Bearer {token} dans chaque requête. Les tokens sont gérés dans Paramètres GitScrum → API. Base URL: https://services.gitscrum.com — Tous les chemins de requête dans cette documentation sont relatifs à cette URL de base.

Créez votre première tâche via l'API en 5 minutes.

Prérequis

  • Un compte GitScrum avec au moins un workspace et un projet
  • Votre token API (voir Authentification)

Étape 1 — Obtenir votre token API

Exportez votre token comme variable d'environnement :

export GITSCRUM_TOKEN="your-api-token-here"

Étape 2 — Lister vos workspaces

curl -X GET https://services.gitscrum.com/workspaces \
  -H "Authorization: Bearer $GITSCRUM_TOKEN" \
  -H "Content-Type: application/json"

Réponse

{
  "data": [
    {
      "slug": "acme-corp",
      "name": "Acme Corp",
      "logo": "https://cdn.gitscrum.com/logos/acme.png"
    }
  ]
}

Copiez la valeur slug — vous en aurez besoin pour les étapes suivantes.

Étape 3 — Lister les projets

curl -X GET "https://services.gitscrum.com/projects?company_slug=acme-corp" \
  -H "Authorization: Bearer $GITSCRUM_TOKEN" \
  -H "Content-Type: application/json"

Réponse

{
  "data": [
    {
      "slug": "web-platform",
      "name": "Web Platform",
      "description": "Main product application",
      "visibility": "public"
    }
  ]
}

Copiez le slug du projet pour l'étape suivante.

Étape 4 — Créer une tâche

curl -X POST https://services.gitscrum.com/tasks \
  -H "Authorization: Bearer $GITSCRUM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "My first API task",
    "company_slug": "acme-corp",
    "project_slug": "web-platform"
  }'

Réponse 201 Created

{
  "data": {
    "uuid": "task-uuid-abc123",
    "title": "My first API task",
    "code": "WEB-42",
    "status": "todo",
    "created_at": "2026-02-07T10:30:00Z"
  }
}

Étape 5 — Vérifier la tâche

curl -X GET https://services.gitscrum.com/tasks/task-uuid-abc123 \
  -H "Authorization: Bearer $GITSCRUM_TOKEN" \
  -H "Content-Type: application/json"

Réponse

{
  "data": {
    "uuid": "task-uuid-abc123",
    "title": "My first API task",
    "code": "WEB-42",
    "status": "todo",
    "workflow": {
      "title": "Backlog"
    },
    "project": {
      "slug": "web-platform",
      "name": "Web Platform"
    },
    "created_at": "2026-02-07T10:30:00Z"
  }
}

Votre tâche est maintenant visible sur le tableau Kanban dans GitScrum.

Prochaines étapes

  • Tâches — Gestion complète des tâches (mise à jour, filtre, assignation, déplacement)
  • Projets — Configuration et statistiques des projets
  • Sprints — Planification et rapports de sprint
  • Suivi du Temps — Suivez le temps sur les tâches
  • Gestion des Erreurs — Gérez les erreurs correctement