Guide complet : comment utiliser l’API REST JIRA pour récupérer et créer des tickets

Benoit Costa

L’API REST JIRA est un outil puissant pour les développeurs et les gestionnaires de projet qui souhaitent automatiser et intégrer les fonctionnalités de JIRA dans leurs applications. Ce guide complet vous expliquera comment utiliser efficacement cette API pour récupérer et créer des tickets, en mettant l’accent sur les meilleures pratiques et les étapes essentielles.

Configurer l’authentification pour l’API JIRA

Avant de pouvoir utiliser l’API REST JIRA, il est primordial de mettre en place une authentification appropriée. La méthode recommandée consiste à utiliser des jetons d’API, qui offrent un niveau de sécurité supérieur aux méthodes d’authentification traditionnelles. Voici les étapes pour configurer l’authentification :

  1. Connectez-vous à votre compte JIRA
  2. Accédez aux paramètres de votre profil
  3. Recherchez l’option « Sécurité » ou « Gestion des jetons API »
  4. Générez un nouveau jeton en lui attribuant un nom descriptif
  5. Copiez et conservez le jeton en lieu sûr, car il ne sera plus affiché ultérieurement

Une fois le jeton généré, vous pouvez l’utiliser pour authentifier vos requêtes API. Il est essentiel de remarquer que ces jetons ont généralement une durée de validité limitée, ce qui renforce la sécurité de vos interactions avec l’API JIRA.

Pour utiliser le jeton dans vos requêtes, vous devrez l’inclure dans l’en-tête d’autorisation de vos appels API. Voici un exemple de format d’en-tête :

Authorization: Bearer <votre_jeton_api>

En implémentant cette méthode d’authentification, vous assurez la sécurité de vos interactions avec l’API JIRA tout en facilitant l’intégration dans vos processus de développement.

Récupérer des tickets via l’API JIRA

L’une des fonctionnalités les plus utiles de l’API REST JIRA est la possibilité de récupérer des informations sur les tickets existants. Cette capacité permet aux développeurs d’intégrer facilement les données JIRA dans leurs propres applications ou tableaux de bord. Voici comment procéder pour récupérer des tickets :

Pour obtenir une liste de tous les tickets, vous pouvez utiliser l’endpoint suivant :

GET /rest/api/2/search

Cet endpoint accepte plusieurs paramètres pour affiner votre recherche. Par exemple :

  • jql : pour spécifier une requête JQL (JIRA Query Language)
  • startAt : pour paginer les résultats
  • maxResults : pour limiter le nombre de résultats retournés
  • fields : pour spécifier les champs à inclure dans la réponse

Voici un exemple de requête pour récupérer les 10 premiers tickets d’un projet spécifique :

GET /rest/api/2/search?jql=project=PROJ&maxResults=10&fields=id,key,summary,status

Cette requête retournera un objet JSON contenant les informations sur les tickets correspondants. Vous pouvez ensuite traiter ces données dans votre application pour les afficher ou les analyser selon vos besoins.

Guide complet : comment utiliser l'API REST JIRA pour récupérer et créer des tickets

Création de tickets avec l’API JIRA

L’API REST JIRA permet également de créer de nouveaux tickets programmatiquement, ce qui est particulièrement utile pour l’automatisation des processus de gestion de projet. Pour créer un ticket, vous devez envoyer une requête POST à l’endpoint approprié avec les détails du ticket dans le corps de la requête.

Voici l’endpoint à utiliser pour créer un nouveau ticket :

POST /rest/api/2/issue

Le corps de la requête doit être au format JSON et contenir les informations nécessaires pour créer le ticket. Voici un exemple de structure de base :


{
    "fields": {
        "project": {
            "key": "PROJ"
        },
        "summary": "Titre du ticket",
        "description": "Description détaillée du ticket",
        "issuetype": {
            "name": "Bug"
        }
    }
}

Il est utile de préciser que les champs requis peuvent varier en fonction de la configuration de votre instance JIRA. Assurez-vous de consulter la documentation spécifique à votre version et configuration pour connaître les champs obligatoires.

Pour faciliter la création de tickets, voici un tableau récapitulatif des champs couramment utilisés :

Champ Description Exemple de valeur
project Clé du projet « PROJ »
summary Titre du ticket « Corriger le bug d’affichage »
description Description détaillée « Le menu déroulant ne s’affiche pas correctement sur mobile »
issuetype Type de ticket « Bug », « Tâche », « Story »
priority Priorité du ticket « High », « Medium », « Low »

En maîtrisant ces aspects de l’API REST JIRA, vous serez en mesure d’intégrer efficacement la gestion des tickets dans vos workflows de développement et d’automatisation. N’oubliez pas de consulter régulièrement la documentation officielle de JIRA pour rester à jour avec les dernières fonctionnalités et bonnes pratiques.

© TNIT 2025