​

Bienvenido a la API de Corgea

​

¿Qué se puede hacer con la API de Corgea?

​

Capacidades de la API

​

Autenticación y autorización

• Verificación de token: Verificar tokens API y recuperar información de usuario
• Flujo de autorización: Intercambia códigos de autorización por tokens API

​

APIs de escaneo

• Iniciar escaneo: Iniciar nuevos escaneos blast con subidas de archivos fragmentadas para grandes bases de código
• Subir resultados de escaneo: Enviar informes de escaneo desde herramientas externas de seguridad
• Obtener escaneos: Recuperar el historial de escaneo con filtrado y paginación
• Obtener detalles del escaneo: Accede a información detallada sobre escaneos específicos
• Informes de escaneo: Generar informes HTML, SARIF o Markdown para escaneos

​

APIs de gestión de incidencias

• Obtén problemas: Enumera todos los problemas de seguridad con las opciones de filtrado
• Obtener detalles del problema: Obtener información completa sobre vulnerabilidades específicas
• Problemas con el SCA: Vulnerabilidades de Análisis de Composición de Software de Acceso (SCA)
• Filtrado de problemas: Filtrar por proyecto, repositorio, urgencia y más

​

Gestión de políticas

• Reglas de bloqueo: Definir y gestionar políticas de seguridad
• Validación de reglas: Comprueba si los escaneos violan las normas de bloqueo
• Aplicación de políticas: Prevenir despliegues basados en políticas de seguridad

​

Base URL

https://www.corgea.app/api/v1

https://<your-instance>.corgea.app/api/v1

​

Autenticación

CORGEA-TOKEN: your_api_token_here

​

Empezando con la autenticación

1. Obtener un token de API: Obtenga su token de API desde la configuración de tu cuenta Corgea
2. Verifica tu token: Utiliza el endpoint /verify para confirmar que el token es válido
3. Información opcional de usuario: Incluir ?user_info=true para obtener datos de usuarios y empresas

​

Métodos de autenticación

curl -H "CORGEA-TOKEN: your_api_token_here" \
     https://www.corgea.app/api/v1/verify

curl https://www.corgea.app/api/v1/verify/your_token_here

​

Flujo de autorización

1. Redirigir a los usuarios a la página de autorización de Corgea
2. Los usuarios autorizan tu aplicación y reciben un código de autorización
3. Intercambia el código por un token de API usando /authorize?code=your_code

​

Formato de respuesta

{
  "status": "ok",
  "data": { }
}

{
  "status": "error",
  "message": "Description of the error"
}

​

Códigos de estado HTTP

​

Paginación

• page: Número de página (por defecto: 1)
• page_size: Número de resultados por página (por defecto: 20, máximo: 50)

{
  "status": "ok",
  "page": 1,
  "total_pages": 5,
  "data": []
}

​

¿Necesitas ayuda?

​

Inicio rápido

1. Obtén tu token de API desde la configuración de tu cuenta Corgea
2. Verifica tu token mediante el endpoint /verify con autenticación por cabecera
3. Haz tu primera petición para subir un informe de escaneo o listar problemas de seguridad