> ## Documentation Index > Fetch the complete documentation index at: https://docs.corgea.app/llms.txt > Use this file to discover all available pages before exploring further. # Referencia API > Empieza con la API de Corgea # Bienvenido a la API de Corgea La API de Corgea te permite interactuar programáticamente con la plataforma de seguridad de aplicaciones de Corgea. Automatiza el escaneo de vulnerabilidades, recupera problemas de seguridad, gestiona correcciones e integra Corgea en tu flujo de trabajo de desarrollo. ## ¿Qué se puede hacer con la API de Corgea? Iniciar escaneos de seguridad, subir resultados de escaneo y monitorizar el progreso del escaneo Recuperar detalles de vulnerabilidades, gestionar el estado del problema y hacer seguimiento de la remediación Accede a correcciones y parches de seguridad generados por IA para vulnerabilidades identificadas Integra el escaneo de seguridad en tus pipelines de integración continua ## 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 Todas las solicitudes de API deben hacerse a: Nuestro entorno multi-inquilino ``` https://www.corgea.app/api/v1 ``` O tu entorno de inquilino único ``` https://.corgea.app/api/v1 ``` ## Autenticación La API de Corgea utiliza autenticación por clave de API. Incluye tu token de API en la cabecera de la solicitud: ```bash theme={null} 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 **Autenticación basada en encabezado** (Recomendada): ```bash theme={null} curl -H "CORGEA-TOKEN: your_api_token_here" \ https://www.corgea.app/api/v1/verify ``` **Autenticación basada en rutas** (Desaprobada): ```bash theme={null} curl https://www.corgea.app/api/v1/verify/your_token_here ``` ### Flujo de autorización Para aplicaciones que necesitan autenticar usuarios: 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` Algunos endpoints, como `/verify/{token}` y `/authorize`, no requieren autenticación. Consulta la documentación de cada endpoint para conocer sus requisitos. ## Formato de respuesta Todas las respuestas de la API se devuelven en formato JSON. Las respuestas correctas incluyen un campo `status`: ```json theme={null} { "status": "ok", "data": { } } ``` Las respuestas al error incluyen mensajes descriptivos: ```json theme={null} { "status": "error", "message": "Description of the error" } ``` ## Códigos de estado HTTP La API utiliza códigos de estado HTTP estándar: | Código | Descripción | | ------ | -------------------------------------------------------------------- | | `200` | Solicitud exitosa | | `400` | Solicitud incorrecta - parámetros o cuerpo de la solicitud inválidos | | `401` | No autorizado - autenticación inválida o ausente | | `404` | Recurso no encontrado | | `429` | Límite de tarifa superado | | `500` | Error interno del servidor | ## Paginación Los endpoints que devuelven listas permiten paginación usando parámetros de consulta: * `page`: Número de página (por defecto: 1) * `page_size`: Número de resultados por página (por defecto: 20, máximo: 50) Las respuestas paginadas incluyen: ```json theme={null} { "status": "ok", "page": 1, "total_pages": 5, "data": [] } ``` ## ¿Necesitas ayuda? Aprende cómo autenticar tus solicitudes API Contacta con nuestro equipo de soporte para recibir ayuda ## Inicio rápido Empieza con la API de Corgea en tres pasos: 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](https://docs.corgea.app/api-reference/uploading-3rd-party-scan/upload-scan) o [listar problemas de seguridad](https://docs.corgea.app/api-reference/issues/list-all-issues) Explora los endpoints de la API en la barra lateral para conocer más sobre la funcionalidad disponible.