DocumentationWorkflowsApps et services
Requête API GitHub node
Requête libre vers l'API GitHub pour les cas que les autres blocs GitHub ne couvrent pas. Utilise ton compte connecté, uniquement des chemins sous api.github.com. Découvre sa configuration, les entrées et sorties, le test et la résolution des erreurs.
8 min de lectureMis à jour le
Fonction du node
Requête libre vers l'API GitHub pour les cas que les autres blocs GitHub ne couvrent pas. Utilise ton compte connecté, uniquement des chemins sous api.github.com.
Utilise Requête API GitHub comme étape clairement définie dans un workflow anymize.
- Traite 1 entrée.
- Fournit 1 sortie aux étapes suivantes.
- S'exécute comme une étape normale du workflow.
Configurer le node
- 01Ouvre un workflow et ajoute Requête API GitHub depuis le catalogue.
- 02Si ton compte GitHub n'est pas encore connecté, connecte-le directement depuis le panneau du node ou dans Connecteurs.
- 03Renseigne les champs requis et associe les valeurs des étapes précédentes.
- 04Teste le node avec un petit jeu de données et vérifie sa sortie.
- 05Relie la sortie réussie et active le workflow après un test complet.
Actions et modes
Choisis la fonction voulue dans Action. Le panneau affiche ensuite les paramètres utiles.
- Récupérer des données (GET)
- Modifier des données
Paramètres
| Champ | Signification | Zone |
|---|---|---|
| Action | Choix: Récupérer des données (GET), Modifier des données | Standard |
| Chemin | Chemin de l'API GitHub, commençant par /, p. ex. /repos/octocat/hello-world/issues. | Standard |
| Paramètres de requête | Ajoutés sous la forme ?clé=valeur. | Standard |
| Méthode | Choix: POST (créer), PUT (définir), PATCH (modifier), DELETE (supprimer) | Standard |
| Contenu (JSON) | Le contenu JSON de la requête. | Standard |
| Compte GitHub | Laisse vide, l'étape utilise alors ton compte GitHub connecté. | Standard |
| Exécuter une fois par élément | Désactivé (par défaut) : le node s'exécute une fois pour tout l'input. Activé : s'il reçoit plusieurs éléments (par ex. de « Séparer la liste »), il s'exécute une fois PAR élément, et {{ $json }} correspond alors à cet élément. C'est ainsi que tu traites une liste de fichiers entrée par entrée. | Standard |
| Si un élément échoue | « Ignorer » écrit un champ `error` pour l'élément en échec et poursuit avec les autres, au lieu de perdre toute l'exécution à cause d'un seul fichier illisible. | Standard |
| Pause entre les éléments (millisecondes) | Attente avant chaque exécution sauf la première. 1000 = 1 seconde par élément. Utile si le service distant te limite. Maximum 300000 (5 minutes). | Standard |
Entrées et sorties
| Entrée | Signification | Type |
|---|---|---|
| Standard | Reçoit le résultat complet de l'étape précédente. | JSON |
| Sortie | Signification | Type |
|---|---|---|
| Standard | Met le résultat à disposition de l'étape suivante au format JSON. | JSON |
Ce node peut traiter les listes élément par élément. La gestion des erreurs et la pause se trouvent dans les paramètres avancés.
Exemple et test
Récupérer ton propre compte : commence avec un petit jeu de données reconnaissable. Vérifie la sortie et utilise uniquement les champs présents.
Exemple de test
{
"path": "/user"
}Accès et sécurité
Le node travaille avec ton propre compte GitHub connecté. Il ne voit et ne modifie que ce que ce compte a le droit de faire. Vérifie les autorisations affichées au moment de la connexion. Le domaine correspondant (Issues, Pull Requests, Dépôts) doit aussi être activé dans les paramètres de ta connexion GitHub sous Connecteurs. Par défaut, tous les domaines sont activés.
Le réglage « Actions autorisées » de ta connexion GitHub sous Connecteurs s'applique aussi à ce node et il est vérifié à chaque exécution. Avec « Lecture seule » ou « Lire et créer des brouillons », seules les actions de lecture s'exécutent : Récupérer des données (GET). Ces actions demandent « Autoriser les modifications » : Modifier des données.
Les clés et identifiants ont leur place dans les Secrets des workflows ou dans tes comptes connectés. Ne les colle jamais en texte clair dans les champs, les données de test ou les descriptions.
Résoudre les erreurs
- Aucune sortie : vérifie la dernière exécution et les champs fournis par le node précédent.
- Variable vide : ouvre la sortie précédente et utilise un nom de champ réellement présent.
- Connexion refusée : reconnecte le service avec les autorisations nécessaires.
- Action bloquée : passe « Actions autorisées » de la connexion sous Connecteurs sur « Autoriser les modifications », ou choisis une action de lecture.
- Liste traitée une seule fois : active l'exécution par élément.