Skip to main content

Importar proyectos mediante la API

Escrito por
Headshot of Josh Emerson

Josh Emerson

Importing projects via the API small

21 de agosto de 2018

0 minutos de lectura

Acabamos de lanzar un nuevo endpoint de API que te permite importar tus repositorios, proyectos, funciones y aplicaciones para monitorearlos en busca de vulnerabilidades.

Es muy fácil de usar. Envías una solicitud con la integración desde la que quieres importar (por ejemplo, GitHub) y el repositorio, proyecto, función o aplicación que quieres seleccionar (por ejemplo, un repositorio específico de GitHub), y nosotros nos encargamos del resto. Si quieres, puedes especificar los archivos que deseas que analicemos en busca de vulnerabilidades, como package.json o Gemfile.lock. De lo contrario, analizaremos todos los archivos de dependencias que encontremos (la profundidad del análisis varía según la integración).

Esta llamada a la API es asíncrona, debido al tiempo que puede tomar completar una importación. Devuelve una respuesta 201 con un encabezado location que especifica el endpoint que debes consultar para obtener actualizaciones sobre el estado del trabajo de importación.

Muchos clientes nos han pedido una forma de importar proyectos a Snyk mediante programación, así que nos entusiasma ver cómo usan la API de importación para integrar mejor Snyk en sus sistemas actuales. Después de probar la API de importación, cuéntanos qué te parece para que podamos saber cómo mejorarla en el futuro.

Algunos de nuestros clientes automatizaron la creación de repositorios y usarán esta API para garantizar que todos los repositorios nuevos se monitoreen automáticamente en busca de vulnerabilidades de seguridad o incumplimientos de las políticas de licencias.

Una solicitud frecuente es importar automáticamente repositorios y aplicaciones sin servidor a medida que se crean. Para ayudarte a empezar, preparamos un pequeño proyecto de código que muestra un ejemplo sencillo de cómo usar la API de repositorios de GitHub para listar todos los repositorios modificados desde un momento determinado e importarlos a Snyk.

Está disponible como módulo npm, así que con un solo comando puedes importar los repositorios nuevos o modificados durante el último día:

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

Por ejemplo, si configuras una tarea Cron, puedes usar este script para importar repositorios automáticamente de forma periódica. También puedes usarlo para configurar mediante programación nuevas organizaciones con todos los proyectos de código que quieras monitorear. Visita nuestra documentación de la API para obtener más información. El acceso a la API de Snyk está disponible solo en los planes de pago.

Comienza con Capture the Flag

Aprende a resolver desafíos de Capture the Flag con nuestro taller virtual 101 a pedido.