Gestion des Erreurs

Codes d'erreur et réponses de l'API GitScrum. Gérez les erreurs de validation, les échecs d'authentification et les erreurs serveur.

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.

L'API GitScrum utilise les codes de statut HTTP standards et retourne des réponses d'erreur JSON structurées.

Codes de statut HTTP

Code	Signification	Description
`200`	Succès	Requête complétée avec succès
`201`	Créé	Ressource créée avec succès
`204`	Pas de contenu	Ressource supprimée avec succès
`400`	Requête invalide	Requête malformée ou paramètres manquants
`401`	Non autorisé	Token d'authentification manquant ou invalide
`403`	Interdit	Authentifié mais permissions insuffisantes
`404`	Non trouvé	La ressource n'existe pas
`422`	Erreur de validation	Le corps de la requête n'a pas passé les règles de validation
`429`	Limite de débit	Trop de requêtes — voir Limites de Débit
`500`	Erreur serveur	Erreur interne du serveur

Format de réponse d'erreur

Toutes les réponses d'erreur suivent une structure cohérente :

{
  "error": "Not Found",
  "message": "The requested resource was not found."
}

Erreurs de validation (422)

Les erreurs de validation incluent des détails au niveau des champs :

{
  "error": "Validation Error",
  "message": "The given data was invalid.",
  "errors": {
    "title": ["The title field is required."],
    "company_slug": ["The selected company slug is invalid."]
  }
}

Chaque clé dans l'objet errors correspond à un champ de la requête, et la valeur est un tableau de messages de validation.

Erreurs d'authentification (401)

{
  "error": "Unauthorized",
  "message": "Invalid or expired token"
}

Vérifiez que votre token est valide et inclus dans l'en-tête Authorization. Voir Authentification.

Erreurs de permission (403)

{
  "error": "Forbidden",
  "message": "You do not have permission to perform this action."
}

Vérifiez que votre compte possède le rôle requis pour le workspace ou le projet.

Bonnes pratiques

Vérifiez les codes de statut — Inspectez toujours le code de statut HTTP avant de parser le corps de la réponse.
Gérez les tentatives — Réessayez les erreurs 429 et 5xx avec un backoff exponentiel. Ne réessayez pas les erreurs client 4xx.
Journalisez les erreurs — Capturez la réponse d'erreur complète (statut, message, objet errors) pour le débogage.
Validez localement — Validez les champs requis avant d'envoyer les requêtes pour éviter les réponses 422 inutiles.
Affichez les messages — Utilisez le champ message pour afficher un retour d'erreur convivial.