Importer des projets via l’API

Nous venons de lancer un tout nouveau point de terminaison d’API qui vous permet d’importer vos dépôts, projets, fonctions et applications afin qu’ils soient surveillés pour détecter les vulnérabilités.

Son utilisation est très simple. Envoyez une requête en indiquant l’intégration depuis laquelle vous souhaitez importer (par exemple, GitHub) ainsi que le dépôt, le projet, la fonction ou l’application visé (par exemple, un dépôt GitHub spécifique), et nous nous occupons du reste. Vous pouvez éventuellement préciser les fichiers que vous souhaitez analyser à la recherche de vulnérabilités, comme package.json ou Gemfile.lock. Sinon, nous analyserons tous les fichiers de dépendances que nous trouverons (la profondeur d’analyse varie selon l’intégration).

Cet appel d’API est asynchrone, car l’importation peut prendre du temps. Il renvoie une réponse 201 avec un en-tête Location qui indique le endpoint à interroger pour obtenir des mises à jour sur l’état de la tâche d’importation.

De nombreux clients nous ont demandé un moyen d’importer des projets dans Snyk par programmation. Nous sommes donc ravis de découvrir comment vous utiliserez l’API d’importation pour mieux intégrer Snyk à vos systèmes actuels. Après avoir testé l’API d’importation, dites-nous ce que vous en pensez afin que nous puissions voir comment l’améliorer à l’avenir !

Certains de nos clients automatisent la création de dépôts. Ils utiliseront cette API pour s’assurer que tous les nouveaux dépôts sont automatiquement surveillés afin de détecter les vulnérabilités de sécurité ou les violations des règles de licence.

Il est fréquent que l’on nous demande d’importer automatiquement les nouveaux dépôts et applications serverless dès leur création. Pour vous aider à démarrer, nous avons créé un petit codebase qui présente un exemple simple : il utilise l’API GitHub Repos pour répertorier tous les dépôts modifiés depuis un moment donné et les importer dans Snyk.

Ce module npm vous permet d’importer en une seule commande les dépôts créés ou modifiés au cours d’une journée :

$ npm install -g snyk-github-import
$ snyk-github-import --orgId=c0caaa2f-6c04-4be3-876b-c72553a5551f --integrationId=ab4633ac-e6bb-4d27-854a-328c0f33c3e8  --githubToken=212312cq1bfb1bcfb13042ff5a13d01ab12f12f4

Par exemple, en configurant une tâche Cron, vous pouvez utiliser ce script pour importer automatiquement des dépôts à intervalles réguliers. Vous pouvez également l’utiliser pour configurer par programmation de nouvelles organisations avec tous les codebases que vous souhaitez surveiller. Consultez notre documentation de l’API pour en savoir plus. L’accès à l’API Snyk est réservé aux offres payantes.