Accès API du Projet

L'onglet API affiche les credentials API de votre projet pour l'accès programmatique et fournit une visibilité sur l'utilisation de l'API à travers les statistiques de rate limit, les graphiques d'utilisation et l'historique des requêtes récentes. Utilisez ces credentials pour intégrer GitScrum avec des outils externes, des scripts d'automatisation et des applications personnalisées.

Aperçu

L'interface affiche des informations d'utilisation de l'API en temps réel organisées en trois sections principales : statistiques de rate limit en haut, un graphique d'utilisation montrant les requêtes des 7 derniers jours, et une table des requêtes récentes faites à votre projet.

Section Rate Limits

La section rate limits affiche trois cartes de statistiques montrant l'état actuel d'utilisation de l'API :

Total des Requêtes

Affiche le nombre total de requêtes API autorisées pendant la période de facturation actuelle. Si votre plan inclut des requêtes illimitées, affiche "Illimité" au lieu d'un nombre.

Disponible

Affiche combien de requêtes restent disponibles pour la période actuelle. Un nombre vert indique une disponibilité saine. Quand votre plan est illimité, affiche aussi "Illimité".

Période

Affiche la plage de dates de la période de facturation actuelle au format "début → fin" (ex : "1 Déc → 31 Déc"). Cela vous aide à comprendre quand votre compteur de requêtes est réinitialisé.

Graphique d'Utilisation

Un graphique à barres affiche le volume de requêtes API sur les 7 derniers jours. Chaque barre représente un jour, avec la hauteur indiquant le nombre de requêtes faites ce jour-là. Le graphique utilise un schéma de couleurs bleu avec :

• Axe X montrant les dates en format court
• Axe Y montrant le compte des requêtes
• Effets hover mettant en évidence les barres individuelles
• État vide montrant des barres plates quand aucune requête n'a été faite

Cette visualisation aide à identifier les patterns d'utilisation et détecter les pics inhabituels dans l'activité API.

Table des Requêtes Récentes

Quand des requêtes API ont été faites à votre projet, une table affiche l'activité la plus récente avec les colonnes suivantes :

Méthode

Affiche la méthode HTTP utilisée pour chaque requête avec des badges colorés :

• GET - Badge vert pour les opérations de lecture
• POST - Badge bleu pour les opérations de création
• PUT - Badge orange pour les opérations de mise à jour
• DELETE - Badge rouge pour les opérations de suppression

Endpoint

Affiche le chemin de l'endpoint API qui a été appelé. Les endpoints longs sont tronqués avec des points de suspension.

Temps

Affiche quand la requête a été faite en utilisant un temps relatif lisible (ex : "il y a 2m", "il y a 1h", "Hier"). Survolez le temps pour voir l'horodatage exact.

Credentials API

Cliquez sur le bouton Obtenir Credentials dans l'en-tête pour ouvrir le modal de credentials. Ce modal fournit les clés d'authentification nécessaires pour accéder à votre projet via l'API.

API ID

Un identifiant unique pour l'accès API. Cette valeur est en lecture seule et ne peut pas être modifiée. Cliquez sur l'icône de copie pour copier dans votre presse-papiers. Une confirmation "Copié" apparaît brièvement après la copie.

Project Key

La clé spécifique au projet utilisée pour l'authentification. Elle est aussi en lecture seule. Cliquez sur l'icône de copie pour copier dans votre presse-papiers.

Régénérer les Credentials

Si vos credentials sont compromis ou si vous devez les faire tourner pour la sécurité :

1. Cliquez sur le bouton Régénérer en bas du modal
2. Le système génère de nouvelles valeurs API ID et Project Key
3. Mettez immédiatement à jour toutes les applications utilisant les anciens credentials
4. Les anciens credentials cessent de fonctionner dès que les nouveaux sont générés

Avertissement : Régénérer les credentials invalide toutes les intégrations existantes utilisant les anciennes valeurs. Planifiez soigneusement votre rotation de credentials.

Documentation API

Cliquez sur le lien Voir documentation en bas du modal de credentials pour ouvrir la documentation complète de l'API sur gitscrum.com. La documentation fournit :

• Référence complète des endpoints
• Détails d'authentification
• Exemples de requête et réponse
• Explications des codes d'erreur

Comprendre les Rate Limits

Les rate limits protègent l'API contre les abus et assurent une utilisation équitable pour tous les utilisateurs. Votre plan détermine vos limites :

• Les limites sont calculées par période de facturation
• Le compteur Disponible diminue au fur et à mesure que vous faites des requêtes
• Le compteur se réinitialise au début de chaque nouvelle période
• Les plans illimités affichent "Illimité" pour le total et le disponible

Surveiller la Santé de l'API

Utilisez l'onglet API régulièrement pour :

1. Vérifier le quota restant - Assurer que vous avez suffisamment de requêtes disponibles
2. Examiner les patterns d'utilisation - Le graphique révèle les tendances d'utilisation quotidienne
3. Auditer l'activité récente - La table des requêtes montre quels endpoints sont appelés
4. Détecter les anomalies - Les pics inhabituels peuvent indiquer des problèmes d'intégration ou un accès non autorisé

Permissions

L'accès aux credentials et statistiques API nécessite des permissions Admin ou Manager du projet. Les membres de l'équipe avec des permissions inférieures ne peuvent pas voir cet onglet.

Fonctionnalités Connexes

• Webhooks - Recevez des notifications en temps réel quand des événements se produisent
• Intégrations - Connectez-vous à Slack, Discord, GitHub et d'autres services