> ## 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. # Référence de l’API > Bien démarrer avec l’API Corgea # Bienvenue dans l’API Corgea L’API Corgea vous permet d’interagir par programmation avec la plateforme de sécurité applicative de Corgea. Automatisez l’analyse des vulnérabilités, détectez les problèmes de sécurité, gérez les correctifs et intégrez Corgea à votre workflow de développement. ## Que peut-on faire avec l’API Corgea ? Lancer des scans de sécurité, charger leurs résultats et suivre leur progression Récupérer le détail des vulnérabilités, gérer l’état des problèmes et suivre leur remédiation Accéder aux correctifs et patches de sécurité générés par l’IA pour les vulnérabilités détectées Intégrez le scan de sécurité dans vos pipelines d’intégration continue ## Fonctionnalités de l’API ### Authentification et autorisation * **Vérification des tokens** : vérifier les tokens d’API et récupérer les informations de l’utilisateur * **Flux d’autorisation** : échanger des codes d’autorisation contre des tokens d’API ### API de scan * **Démarrer un scan** : lancer de nouveaux scans BLAST avec un chargement de fichiers par blocs pour les grands volumes de code * **Charger les résultats d’un scan** : envoyer les rapports d’outils de sécurité externes * **Récupérer les scans** : consulter l’historique avec filtres et pagination * **Récupérer le détail d’un scan** : accéder aux informations détaillées d’un scan * **Rapports de scan** : générer des rapports HTML, SARIF ou Markdown ### API de gestion des problèmes * **Récupérer les problèmes** : répertorier tous les problèmes de sécurité avec des options de filtrage * **Récupérer le détail d’un problème** : obtenir toutes les informations sur une vulnérabilité * **Problèmes SCA** : accéder aux vulnérabilités détectées par l’analyse de composition logicielle (SCA) * **Filtrage des problèmes** : filtrer par projet, dépôt, urgence, etc. ### Gestion des politiques * **Règles de blocage**: Définir et gérer les politiques de sécurité * **Validation des règles**: Vérifiez si les scans enfreignent les règles de blocage * **Application des politiques**: Empêcher les déploiements basés sur des politiques de sécurité ## Base URL Toutes les requêtes d’API doivent être envoyées à l’une des URL suivantes : Notre environnement multi-locataire ``` https://www.corgea.app/api/v1 ``` Ou votre environnement monolocataire ``` https://.corgea.app/api/v1 ``` ## Authentification L’API Corgea utilise une authentification par clé API. Ajoutez votre token d’API à l’en-tête de la requête : ```bash theme={null} CORGEA-TOKEN: your_api_token_here ``` ### Bien démarrer avec l’authentification 1. **Obtenir un token d’API** : récupérez-le dans les paramètres de votre compte Corgea 2. **Vérifier votre token** : utilisez l’endpoint `/verify` pour confirmer sa validité 3. **Récupérer éventuellement les informations de l’utilisateur** : ajoutez `?user_info=true` pour obtenir les informations de l’utilisateur et de l’entreprise ### Méthodes d’authentification **Authentification par en-tête** (recommandée) : ```bash theme={null} curl -H "CORGEA-TOKEN: your_api_token_here" \ https://www.corgea.app/api/v1/verify ``` **Authentification par chemin** (obsolète) : ```bash theme={null} curl https://www.corgea.app/api/v1/verify/your_token_here ``` ### Flux d’autorisation Pour les applications qui doivent authentifier les utilisateurs : 1. Redirigez les utilisateurs vers la page d’autorisation de Corgea 2. Les utilisateurs autorisent votre application et reçoivent un code d’autorisation 3. Échangez le code contre un token d’API avec `/authorize?code=your_code` Certains endpoints, tels que `/verify/{token}` et `/authorize`, ne nécessitent pas d’authentification. Consultez la documentation de chaque endpoint pour connaître ses exigences. ## Format de réponse Toutes les réponses de l’API sont au format JSON. Les réponses réussies contiennent un champ `status` : ```json theme={null} { "status": "ok", "data": { } } ``` Les réponses à l’erreur incluent des messages descriptifs : ```json theme={null} { "status": "error", "message": "Description of the error" } ``` ## Codes de statut HTTP L’API utilise les codes de statut HTTP standard : | Code | Description | | ----- | ------------------------------------------------------- | | `200` | Demande réussie | | `400` | Requête incorrecte : paramètres ou corps non valides | | `401` | Non autorisé : authentification non valide ou manquante | | `404` | Ressource non trouvée | | `429` | Limite de débit dépassée | | `500` | Erreur interne du serveur | ## Pagination Les endpoints qui renvoient des listes prennent en charge la pagination au moyen de paramètres de requête : * `page`: Numéro de page (par défaut : 1) * `page_size`: Nombre de résultats par page (par défaut : 20, max : 50) Les réponses paginées contiennent : ```json theme={null} { "status": "ok", "page": 1, "total_pages": 5, "data": [] } ``` ## Besoin d’aide ? Découvrez comment authentifier vos requêtes d’API Contactez notre équipe de support pour obtenir de l’aide ## Démarrage rapide Commencez à utiliser l’API Corgea en trois étapes : 1. **Récupérez votre token d’API** dans les paramètres de votre compte Corgea 2. **Vérifiez votre token** avec l’endpoint `/verify` et l’authentification par en-tête 3. **Envoyez votre première requête** pour [téléverser un rapport d’analyse](https://docs.corgea.app/api-reference/uploading-3rd-party-scan/upload-scan) ou [lister les problèmes de sécurité](https://docs.corgea.app/api-reference/issues/list-all-issues) Explorez les endpoints de l’API dans la barre latérale pour découvrir les fonctionnalités disponibles.